![]() This is a single file containing all HTML files and it also includes a search index. If you are running doxygen on Windows, then you can make a compiled HTML Help file (.chm) out of the HTML files produced by doxygen. Also the search results have better ranking and show context information (if available).ĭisadvantages are that is requires a web server that can execute a CGI binary, and an additional indexing step after running doxygen. The way the interaction with the search engine is done, makes it possible to search from local HTML pages. It is also possible to combine multiple doxygen projects and external data into one search index. See External Indexing and Searching for configuration details.Īdvantages over option 2 are that this method (potentially) scales to very large projects. To enable this search method set SEARCHENGINE, SERVER_BASED_SEARCH and EXTERNAL_SEARCH all to YES. To make life easier doxygen ships with an example indexer (doxyindexer) and search engine (doxysearch.cgi) based on the Xapian open source search engine library. With this option doxygen generates the raw data that can be searched and leaves it up to external tools to do the indexing and searching, meaning that you could use your own indexer and search engine of choice. With release 1.8.3 of doxygen, another server based search option has been added. Server side searching with external indexing Note In the future this option will probably be replaced by the next search option. using a "file://" URL) and that it does not provide live search capabilities. To enable this set both SEARCHENGINE and SERVER_BASED_SEARCH to YES in the configuration file and set EXTERNAL_SEARCH to NO.Īdvantages over the client side search engine are that it provides full text search and it scales well to medium side projects.ĭisadvantages are that it does not work locally (i.e. If you plan to put the HTML documentation on a web server, and that web server has the capability to process PHP code, then you can also use doxygen's built-in server side search engine. STR it will only find STRING and not A_STRING. Furthermore the searching is done from the beginning of the indexed items, so when having the available items A_STRING, AA_STRING and STRING and typing in the search box A it will find A_STRING and AA_STRING, but when typing e.g. It does not provide full text search capabilities and it does not scale well to very large projects (then searching becomes very slow). This method also has its drawbacks: it is limited to searching for symbols only. the search results are presented and adapted as you type. To enable it set SEARCHENGINE to YES in the configuration file and make sure SERVER_BASED_SEARCH is set to NO.Īn additional advantage of this method is that it provides live searching, i.e. So no additional tooling is required to make it work. This engine is implemented using JavaScript and DHTML only and runs entirely on the clients browser. The easiest way to enable searching is to enable the built-in client side search engine. ![]() HTML browsers by default have no search capabilities that work across multiple pages, so either doxygen or external tools need to help to facilitate this feature.ĭoxygen has 7 different ways to add searching to the HTML output, each of which has its own advantages and disadvantages: 1. ![]() There are also situations however where you want to search for something by keyword rather than browse for it. Doxygen indexes your source code in various ways to make it easier to navigate and find what you are looking for.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |