Groups | Search | Server Info | Login | Register

Groups > comp.lang.java.programmer > #5421

Re: The greeting code in Java

Show all headers | View raw

On Sun, 19 Jun 2011 20:24:13 +0000, Stefan Ram wrote:

> Martin Gregorie <martin@address-in-sig.invalid> writes:
>>C/C++ doesn't have a standard documentation tool that comes near
>>Javadocs.
> 
>   Classical C was part of UNIX, and its »standard documentation tool«
>   was »(n|g)roff -man«/»man«.
>
Indeed - and this is not exactly or portable (as you said) and rarely 
found outside the *NIX world.

IMO the main advantage of Javadocs over virtually all the other program 
documentation tools is that it can generate documentation from a program 
source that follows the conventions and requires a minimum of of 
documentary annotation. Compare that with the requirement that C 
documentation must be a separately maintained (n|g)roff text file that 
can be almost unreadable in raw form, though the latest versions of less 
do remove a lot of the formatting and checking nausea. 

However, less, like (g|n)roff is also almost unknown outside the *NIX 
world.
 
>   However, it has not been man portable together with C
>
Indeed - text editors are everywhere but the same can't be said about 
(n|g)roff.

I ended up writing my own Javadocs knock-off for C (cdoc) that can 
generate HTML that approximates a cross between Javadocs indexing/
pagination and the usual C library documentation format. It can do a 
reasonable job of documenting unmodified C source provided only that it 
has a heading comment for the C source file and a preceding comment for 
each function. 

Its also highly portable, since I wrote it in Java.


-- 
martin@   | Martin Gregorie
gregorie. | Essex, UK
org       |

Back to comp.lang.java.programmer | Previous | Next — Previous in thread | Next in thread | Find similar

Thread

The greeting code in Java Saeed Amrollahi <amrollahi.saeed@gmail.com> - 2011-06-19 06:05 -0700
  Re: The greeting code in Java rossum <rossum48@coldmail.com> - 2011-06-19 17:36 +0100
    Re: The greeting code in Java Saeed Amrollahi <amrollahi.saeed@gmail.com> - 2011-06-19 12:15 -0700
      Re: The greeting code in Java Martin Gregorie <martin@address-in-sig.invalid> - 2011-06-19 19:46 +0000
        Re: The greeting code in Java Saeed Amrollahi <amrollahi.saeed@gmail.com> - 2011-06-19 22:34 -0700
          Re: The greeting code in Java Jukka Lahtinen <jtfjdehf@hotmail.com.invalid> - 2011-06-23 11:43 +0300
        Re: The greeting code in Java Martin Gregorie <martin@address-in-sig.invalid> - 2011-06-20 10:13 +0000
          Re: The greeting code in Java Michael Wojcik <mwojcik@newsguy.com> - 2011-06-22 09:29 -0400
      Re: The greeting code in Java Joshua Cranmer <Pidgeot18@verizon.invalid> - 2011-06-19 16:00 -0400
      Re: The greeting code in Java Eric Sosman <esosman@ieee-dot-org.invalid> - 2011-06-19 16:05 -0400
        Re: The greeting code in Java Saeed Amrollahi <amrollahi.saeed@gmail.com> - 2011-06-19 22:40 -0700
      Re: The greeting code in Java rossum <rossum48@coldmail.com> - 2011-06-19 22:28 +0100
  Re: The greeting code in Java Roedy Green <see_website@mindprod.com.invalid> - 2011-06-19 21:14 -0700
  Re: The greeting code in Java Roedy Green <see_website@mindprod.com.invalid> - 2011-06-19 21:23 -0700
  Re: The greeting code in Java blmblm@myrealbox.com <blmblm.myrealbox@gmail.com> - 2011-06-20 19:20 +0000
    Re: The greeting code in Java Ney André de Mello Zunino <zunino@softplan.com.br> - 2011-06-22 15:55 -0300

csiph-web