logo       

Re: how to use the autodoc feature of new swig-1.3.22?: msg#00075

programming.swig

Subject: Re: how to use the autodoc feature of new swig-1.3.22?

On Wed, Sep 08, 2004 at 12:56:21AM -0400, Josh Cherry wrote:

> I find it quite nice to see this in a graphical web browser ...

I agree. I actually considered this solution. The main problems are

1. It is not easy to locate document for a class/function. I am not sure
if there are options to change this but links to classes/functions in
my html file are meaningless numbers like a000087#r0 . The
references will change if I add classes/functions. What makes things
worse is that I use template a lot. This introduces technique
difficulties like mapping instance class name to template class name.

2. The HTML pages are nice, but come with a cost of running an instance
of browser. I guess this is the reason why R/S-Plus/Matlab etc all
provide two sets of help systems: a help function and a set of
webpages.

> I can send the details of how I attach the function to all the classes
> and launch a web browser if you're interested.

Even if I will implement a text-based help system later, it is nice to
have a web-based help system. I am curious about how you deal with
problem 1, could you please PM me your code?

Thank you very much.

--
Bo Peng
_______________________________________________
Swig maillist - Swig@xxxxxxxxxxxxxxx
http://mailman.cs.uchicago.edu/mailman/listinfo/swig



<Prev in Thread] Current Thread [Next in Thread>
Google Custom Search

News | FAQ | advertise