Hello,
I apologize for my English, but I am learning it
This subject more has a relation to the lcl and lazutils docs but the fpc documentation has same problems. A have spend more times for improving a documentation but exists the one problem. Currently, we have a rule - if there is no description xml file, the unit is not included to the documentation (that rule has been coded into a build_lcl_docs). As result the FPDoc has no input information to build a tree of classes. And class information pages have the skips in the tree of classes.
For example as here.
https://lazarus-ccr.sourceforge.io/docs/lcl/intfgraphics/tlazreaderbmp.htmlI see two solutions of that:
1. Allow directory processing with files and include all modules from specific directories for the processing by fpdoc (This information are prepared by build_lcl_docs ).
2. Explicitly and at ones to create empty blank templates of the xml description files. The LazUtils has 14 unprocessed files. lcl has about 350 files but 95% from these are interface classes and don`t require to be included into documentation.
I think that the second solution is better, because this solves two tasks. We get the right information about inheritance and create blank templates for contributors that facilitate the creation of documentation.
And if someone fill out at least a description or a short description of the module, that will be super. Unfortunately, I can not do it, my English is very bad.
What is your opinion about this and can someone create templates with a brief description?
Log file of build_lcl_docs attached.
Andrey Sobol.