Generating Documentation with IDEA?

Hello everyone,

We need to produce some basic documentation (inventory) for all files in our
projects - java (javadoc) various XML metadata, JSPs, XSLT stylesheet, CSS,
properties and other config files ....
It would be really great if we could put file level comments in those files
and have Idea to extract them and produce one nice inventory document a la
JavaDoc
It would be really nice if Idea would support javadoc like tags in comments
those other file types

It would be great if Idea could generate project
directory/file list with description for each file extracted out of comments
in those files. Providing navigation to file sources and cross references
for files Idea understand would be great too.

As output I would actually prefer XML file containing directories and files
with parsed out comments for each file/directory. For file types where
support for javadoc is provided those tags should be parsed out and stored
in XML as well. A default XSLT style to output this XML can be optionally
provided

What do you think? Would it be useful for you? Any other thoughts on
documenting project?

Thanks

Alex


1 comment

I think it would be useful (except for the bloated XML part, but may be
necessary to suit everyone's style requirements). This would probably
be a better plugin, than an IntelliJ feature.

Norris Shelton
Sun Certified Java Programmer




Alex Roytman wrote:

>Hello everyone,
>
>We need to produce some basic documentation (inventory) for all files in our
>projects - java (javadoc) various XML metadata, JSPs, XSLT stylesheet, CSS,
>properties and other config files ....
>It would be really great if we could put file level comments in those files
>and have Idea to extract them and produce one nice inventory document a la
>JavaDoc
>It would be really nice if Idea would support javadoc like tags in comments
>those other file types
>
>It would be great if Idea could generate project
>directory/file list with description for each file extracted out of comments
>in those files. Providing navigation to file sources and cross references
>for files Idea understand would be great too.
>
>As output I would actually prefer XML file containing directories and files
>with parsed out comments for each file/directory. For file types where
>support for javadoc is provided those tags should be parsed out and stored
>in XML as well. A default XSLT style to output this XML can be optionally
>provided
>
>What do you think? Would it be useful for you? Any other thoughts on
>documenting project?
>
>Thanks
>
>Alex
>
>

>

0

Please sign in to leave a comment.