On 09/04/2021 12:35 pm, Roland Chastain wrote: > I am playing with the latest release of PasDoc.
Not again! This has been raised so many times over the years. Martin (and I) full agreed that PasDoc is not the way to go, because it requires the source code to be bloated with documentation and code examples. A better alternative: * "fpdoc" comes standard with FPC. * It supports multiple output formats. * Is very well supported. * And most importantly, supports external documentation (not included in the source code files). I've already started fpdoc based documentation back in 2015 to show Martin and the MSEide+MSEgui community. But the uptake of somebody actually writing the documentation has never happened. I only use the IDE of this project, so was not going to consume all my time learning MSEgui, just to document it. However, I did put some time into it: https://github.com/graemeg/msegui/tree/api-docs/contributed In the above like I did the following: * Created a fpdoc project file. Makes things so much easier than adding all those command line parameters in manually. * Created documentation for 3 MSEgui units * Found existing txt based documentation and moved what I could understand to the XML format. * Generated INF binary help output to show usage with DocView. I thought this would be a good enough proof of concept. https://github.com/graemeg/msegui/releases/tag/docs-s2 You can read all about it here (mailing list archive), with screenshots. https://sourceforge.net/p/mseide-msegui/mailman/mseide-msegui-talk/thread/55E72659.7050201%40geldenhuys.co.uk/#msg34427184 Regards, Graeme -- fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal http://fpgui.sourceforge.net/ My public PGP key: http://tinyurl.com/graeme-pgp _______________________________________________ mseide-msegui-talk mailing list mseide-msegui-talk@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk
