[lwip-users] Re: [lwip] Suggestion: javadoc

[John C. Toman]

Hi Kenneth,

You can get doxygen from www.doxygen.org. Or if you have a linux system 
with one of the major distributions, it's probably already on it. From 
doxygen, you can produce html, postscript, latex, etc.

Here's a javadoc function sample (this is one of mine from a Java file; 
doxygen supports the same tags in C files):

    /**
     * Check to see if the configuration file needs to be reloaded, and 
reload
     * it if it has changed on the disk.
     *
     * @return true if the configuration file was reloaded, false otherwise.
     * @exception IOException When the configuration file isn't loaded.
     */
    public boolean checkConfiguration()
        throws IOException
    {

        // if the configuration file has changed on the disk
        // minute, do so.

        long modifyTime = configFile.lastModified();
        if (modifyTime > this.configTime)
        {
            loadConfiguration();
            return true;
        }
        else
        {
            return false;
        }

    }

And so on...

Regards,

John

Kenneth Porter wrote:

>On Tue, 2002-08-20 at 03:15, Paul Sheer wrote:
>
>  
>
>>  - awk is supported on every Unix platform, nothing
>>  need be installed to compile documentation.
>>    
>>
>
>What do you need to install for Javadoc?
>
>  
>
>>  - docs can be read without compiling.
>>    
>>
>
>What does javadoc source look like? Is it unreadable?
>
>  
>
>>  - web docs will always be in sync with ascii docs.
>>  because they recompile instantly with each build.
>>    
>>
>
>Build both from a common markup language, and they're still instantly
>accessible after compiling.
>
>  
>
>>A sample document is:
>>    
>>
>
>  
>
>>The double line creates a major header. Here is an
>>example of an indented list:
>>
>>  1. This paragraph will be indented.
>>
>>  2. So will this one.
>>    
>>
>
>Hard to maintain for a long list, when you need to insert a new item at
>the the beginning of the list.
>
>  
>
>>URLs will be turned into hyperlinks for example
>>http://this.com/ will become a hyperlink in HTML.
>>    
>>
>
>How would escapes work? If you don't want a hyperlink? If text looks
>like a hyperlink but isn't?
>
>  
>
>>Images will be creates as image links. For example
>>(See someimg.jpg.)
>>    
>>
>
>Similar problem.
>
>A big advantage of an existing format is that lots of tools exist to
>manipulate it. No need to re-invent wheels. It's not like the build
>tools have to run on our tiny targets.
>
>[This message was sent through the lwip discussion list.]
>  
>




[This message was sent through the lwip discussion list.]