I'm working on a Perl project that uses NaturalDocs and I miss being able to
run 'perldoc Whatever.pm' on the file I'm looking at to see the documentation.
Is there a command-line viewer for NaturalDocs? Or an option to convert then
to nroff so they can be viewed like man pages?
If not, I'm working on something to merge POD and NaturalDocs to feed it to
nroff. Is there a formal description of NaturalDocs syntax, BNF or otherwise?
I looked around and couldn't find one.
Any pointers would be helpful, thanks!
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
No and no. If you're going through the trouble of building something though,
you can make a very simple command line launcher because the generated output
file paths are pretty straightforward. /files mirrors the subdirectories of
the input directory, replaces the final dot with a dash, and adds .html, so
MySource/PkgA/PkgB/Module.pm
maps to
MyOutput/files/PkgA/PkgB/Module-pm.html
assuming -i MySource and -o HTML MyOutput. This won't work if there are
multiple input folders though because then the output gets divided up into
files, files2, etc.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I'm working on a Perl project that uses NaturalDocs and I miss being able to
run 'perldoc Whatever.pm' on the file I'm looking at to see the documentation.
Is there a command-line viewer for NaturalDocs? Or an option to convert then
to nroff so they can be viewed like man pages?
If not, I'm working on something to merge POD and NaturalDocs to feed it to
nroff. Is there a formal description of NaturalDocs syntax, BNF or otherwise?
I looked around and couldn't find one.
Any pointers would be helpful, thanks!
No and no. If you're going through the trouble of building something though,
you can make a very simple command line launcher because the generated output
file paths are pretty straightforward. /files mirrors the subdirectories of
the input directory, replaces the final dot with a dash, and adds .html, so
MySource/PkgA/PkgB/Module.pm
maps to
MyOutput/files/PkgA/PkgB/Module-pm.html
assuming -i MySource and -o HTML MyOutput. This won't work if there are
multiple input folders though because then the output gets divided up into
files, files2, etc.