Re: [Doxygen-develop] JavaScript version of search.php for local file access

[Jake C. <co...@pp...>]

Roger,

First, I think this would be a great feature.  I have also faced the
problem where my Doxygen-generated files are not always served by a
server and, in that case, I cannot search.

I have implemented and submitted several features and fixes to Doxygen;
the process is very simple.  

1) Checkout the subversion source tree and build the system.
2) Implement and test your changes.
3) Create a patchset of your changes using 'diff' and tar them up into a
   file.
4) Create an enhancement request on Doxygen's bugzilla.  Edit that
   request and attach your patch indicating that you have implemented
   the solution.

Personally, I usual email Dimitri first to make sure that he would
consider accepting my patch before investing the time.  In some cases he
has given advice as to how he would like to see the solution implemented
and in one case he made it clear that he did not like what I was
proposing.

Good luck.

...Jake


>>>>> "RS" == Roger Spooner <ro...@pi...> writes:

   RS> Hi. I'm using Doxygen to write documents for several commercial SDKs 
   RS> which will be delivered as Zip files, and which need a search feature. 
   RS> Asking users to upload our files to an HTTP server so that they can run 
   RS> search.php is not ideal.

   RS> I think it would be possible to reimplement search.php using JavaScript 
   RS> for running locally in a browser. This would then need to be configured 
   RS> as an option in Doxygen to change what appears on each page, and what is 
   RS> copied to the output directory. I haven't edited the source of Doxygen 
   RS> before, so I have two questions.

   RS> 1. Does this JavaScript sound like a good and novel solution? Surely 
   RS> people have faced the problem of searching local Doxygen files before?

   RS> 2. Is there any advice around to guide me in editing the Doxygen code, 
   RS> so that it gets back into the main releases safely? ie schedule, patch 
   RS> files, coding style? I haven't started yet (but I have contributed to 
   RS> mscgen).

   RS> I would imagine using XMLHttpRequest to open search.idx and with partial 
   RS> HTTP GET commands. If this was used from a remote server, it would work, 
   RS> but would be slower.

   RS> Regards,
   RS> Roger

   RS> -------------------------------------------------------------------------
   RS> Check out the new SourceForge.net Marketplace.
   RS> It's the best place to buy or sell services for
   RS> just about anything Open Source.
   RS> http://sourceforge.net/services/buy/index.php

-- 
Jake Colman
Director of Software Development
Principia Partners LLC
101 West Elm Street
Suite 620
Conshohocken, PA  19428
+1 (610) 755-9786
www.principiapartners.com