Re: proxy documentation

[Joe Vaughan <joev@freddyfrog.com>]

Some time in June, Ueli Rutishauser said:
> Hallo Hakan,
> 
> Answer to a message from Hakan Ardo <hakan@debian.org> to dev@mnemonic.browser.org:
> 
>  >> I have tested this only with squid (only linux). please test it and
>  >> send me bug reports or comments :)  (special Netscape and cern proxy's
>  >> must be tested)  
> 
>  > Why split up the docs in doc++ comments and a proxy.txt? The .txt file
>  > should not be needed as that is what doc++ generates from the comments!
>  > I'd say that the prefered way to do this would be to place all the docs
>  > in doc++ comments...
> i have made this because i have some problems with doc++. when you
> look to www.jung96.or.at/~urut/mnemonic/ProtocolHandler.html you see
> my text without any linefeeds - in the source are many of them. what
> is wrong ? i have made the html-file with doc++ -H filename . i see
> that as example the documentation for the netmanager have also
> linefeeds in the source and in the doc++ documentation, so this can
> be a problem of me (the same problem in my DNS class documentation;
> www.jung96.or.at/~urut/mnemonic/DNS.html).
> when this problems are solved, i think i integrat all documentations
> in the doc++ three. 


The  answer to this is simple. You should encapsulate your comments in
HTML tags. In the OM docs, I'm putting in specific <BR> tags at the
end of lines I want spaced out specifically, though it occurs to me
that you could just do 

/** <PRE>
    Your comments. </PRE> */

BTW: I've uploaded the OM... it's currently untested, (I've been a
little short on time the last few days) and some tweaking is
necessary. I believe there is some problem with the objectmanager
directory in the CVS repository (caused no doubt by my lack of
understanding of CVS). I wonder if Hakan would take a look and see if
he can fix what I have broken.

Joe.

-- 
Joe Vaughan           joev@freddyfrog.com
-----------------------------------------
"Play with rocks, prepare to get stoned."