Hi
I've created a 'api-docs' branch, based on the latest MSEgui. I had the
files lying around, and instead of going to waste, I thought I would
share it to Github.
The branch contains a fpdoc project file for all of MSEgui. Currently
only the msesplitter.pas unit has some actual documentation - based on a
recent message from Martin in this mailing list. But even the skeleton
documentation is still very useful when searched.
I then tagged this as a "documentation snapshot 1" release and attached
a pre-built INF file (viewable with DocView).
https://github.com/graemeg/msegui/releases
To view INF help files, use fpGUI's DocView - binaries downloadable from
http://sourceforge.net/projects/fpgui/files/fpGUI/1.4/
See the attached screenshot of how it looks in DocView.
To generate new documentation, simply run fpdoc as follows:
$> fpdoc --project=msegui-docs-project.xml
You can edit the msegui-docs-project.xml and switch it to HTML or CHM
output too. The INF is by far the most efficient and fastest help format
though, and combined with Docview's features like searching, inline
annotations - very useful indeed.
I don't actually use MSEgui (only the IDE portion of the project), but I
do know that API documentation is a vital part of any framework's
success. So I welcome others to contribute to this effort so that MSEgui
can finally have some real API documentation. The idea is to keep adding
little bits at a time (especially if Martin shares some knowledge via
the mailing list), and eventually it will become more and more useful to
new comers.
Maybe if this gets enough interest it could one day be merged into the
official MSEide+MSEgui repository.
Regards,
- Graeme -
--
fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal
http://fpgui.sourceforge.net/
------------------------------------------------------------------------------
Monitor Your Dynamic Infrastructure at Any Scale With Datadog!
Get real-time metrics from all of your servers, apps and tools
in one place.
SourceForge users - Click here to start your Free Trial of Datadog now!
http://pubads.g.doubleclick.net/gampad/clk?id=241902991&iu=/4140
_______________________________________________
mseide-msegui-talk mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk
