FileDoc - Extracting "Docs" From different file types

It would be really great if Idea could extract file level docs from various
file types it understands. Basically what I want is some simplified project
documentation for all project files. Just like JavaDoc but file level only.
The most important files in addition to java would be JSP, XML, CSS,
properties etc. 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.
Extended javadoc might be way to go - project doc which generate as much for
different file types as Idea can. For example for Java files it would be
javadoc, for XML, JSP it could be just a top level comment etc


1 comment

Actually if you also supported javadoc-like tags in other file types
comments it would be really great

"Alex Roytman" <roytmana@peacetech.com> wrote in message
news:cmgl07$q8k$1@is.intellij.net...

It would be really great if Idea could extract file level docs from
various file types it understands. Basically what I want is some
simplified project documentation for all project files. Just like JavaDoc
but file level only. The most important files in addition to java would be
JSP, XML, CSS, properties etc. 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.
Extended javadoc might be way to go - project doc which generate as much
for different file types as Idea can. For example for Java files it would
be javadoc, for XML, JSP it could be just a top level comment etc



0

Please sign in to leave a comment.