Extension:Doxysearch

The Doxysearch extension provides a simple interface for Doxysearch(Doxygen search engine).

Preparing doxysearch engine
For the detailed information, see following manual :
 * Doxygen Manual: External Indexing and Searching

Edit Doxyfile and make sure to set following options: % vim Doxyfile SEARCHENGINE          = YES SEARCHENGINE_URL = https://located/path/of/doxysearch.cgi SERVER_BASED_SEARCH   = YES EXTERNAL_SEARCH       = YES

If you do not have  and   on your system, you need to build them from the source code of doxygen.

Copy  to your Doxygen directory: cd ~/path/to/Doxygen/html cp ~/Downloads/doxygen-1.8.5/bin/doxysearch.cgi. Execute  at   and move generated   to   directory: % cd ~/path/to/Doxygen % ~/Downloads/doxygen-1.8.5/bin/doxyindexer searchdata.xml Processing searchdata.xml... % mv doxysearch.db html Also, edit  and give   option to the directory where   is located.  Options +ExecCGI AddHandler cgi-script .cgi 

Configuration parameters
$wgDoxysearchEngines = array(   'engine_name1' => array( 'name' => 'Engine name 1', 'url' => 'https://examples1.com/doxysearch.cgi', 'auth' => 'digest', 'user' => 'user', 'password' => 'password', 'ssl_verifypeer' => False, 'ssl_verifyhost' => False, ),   'engine_name2' => array( 'name' => 'Engine name 2', 'url' => 'http://examples2.com/doxysearch.cgi', ), );
 * $wgDoxysearchEngines: Set $wgDoxysearchEngines to register doxysearch engines. For example,
 * Parameters of an array are explained below:
 * name
 * Full name of the Doxysearch engine.
 * url
 * URL of a Doxysearch engine which is provided with doxysearch.cgi.
 * auth
 * Method for the authentication of HTTP(S). You can choose the method from,   or  (no authentication).   is set if you do not set this parameter.
 * user
 * User name for the authentication of HTTP(S).
 * password
 * Password for the authentication of HTTP(S).
 * ssl_verifypeer
 * Whether to verify SSL certificate. The default is True.
 * ssl_verifyhost
 * verify SSL host name. The default is True.

Usage

 * Search "ExampleClass" from a search engine located at https://www.example.com/documentation/doxysearch.cgi where an authentication is required with ignoring verifications of SSL certificate and host name :


 * Search "ExampleClass" from the search engine "engine_name" which was registered in $wgDoxysearchEngines set at your LocalSettings.php :


 * Show 3rd result as the first :


 * Specify number of results and page number :


 * Specify separators between keys and separators between items :