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

[Kenneth Porter]

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.]