Menu
▾
▴
#45 Generate separate files for members
Hello,
in the current state, all members of a class are stored in a single HTML file. For large classes it is hard to navigate through the members, especially in internal documentation containing all visiblities. It would be nice to have a Delphi help like output where the description part is split into separate files for each member, containing a link back to the class and unit summary. There could be a command line option for this, like --separate-files.
I'd like to also see this implemented for the Unit output.
Regards,
Danny
This is already implemented in PasDoc2, as an ItemFiles property. See the last PasDoc2-beta7.
I tried to create a file structure similar to the Delphi online help, where e.g. subroutines and methods reside in their own files. More features may be desireable with this file structure, e.g. --numericfilenames should be used to prevent name clashes with overloaded methods. Instead of a command line option, a new output format 'htmlfiles' could be defined, or a variation of 'htmlhelp'.
DoDi
I had a look at beta7. Could it be that this version is somewhat broken? The --ignore-leading command line option isn't working, --numericfilenames produces files like " 1.html" instead of "00000001.html" and autodoc produces lots of errors but no files. I could work around the first two and then it produced correct output for my code.
But now the question is, how do I activate ItemFiles? It seems to be in PasDoc_GenHTML.pas only for the "old" define, so I set this. But even if I set FItemFiles to true in the TGenericHTMLDocGenerator constructor, PasDoc will not produce separate files.
As for the filenames, I would suggest a general format of Unit.Class.Method.N.html or Unit.Routine.N.html, where N is a counter for the method or routine. There would be no name clashes this way.
Danny