On 28/12/2018 13:18, code dz wrote:
> i am not discouraging but the codebase is really massive and complex ,
> and the worst thing is that martin didn't put any comment in his code
> , i asked him once about this but he said (i understand my code as is)
Martin definitely liked control of MSEide+MSEgui, and nobody else got
direct commit access as far as I know. He did on occasion accept pull
requests. Of the many I sent, some of mine did get past his QA. :-)
One of those was the start of API + Class documentation using the
external fpdoc tool (part of FPC and what FPC uses to document their
classes). That means the code can be documented, but outside the *.pas
files. Thus the *.pas files do not get obfuscated with comments/docs,
but the documentation is still tightly linked to the code. Like Martin,
I prefer to keep the code clean and without documentation - and use
external documentation instead. You can find the start of such
documentation here:
https://gitlab.com/mseide-msegui/mseuniverse/tree/master/docs/fpdocSee the README.txt file for further details. Some past releases of
generated help can be found on my personal Github page here:
https://github.com/graemeg/msegui/releasesI generated help in the INF help format, but other output targets can
also be used. eg: HTML, PDF etc.
What I did was every now and then when Martin mentioned something
interesting or not obvious about MSEgui usage, I added such information
as part of the documentation. So over time such documentation will
become more and more useful. Anybody could go over Martin's replies and
keep adding more to the docs - they are simple format XML files.
Like I always say in other Open Source projects I work on, these mailing
lists & newsgroups are a treasure trove of information. A knowledge base
of sorts. So when in doubt, search the past messages for help. Someone
else most likely asked a similar question before. Martin might be gone,
but the huge amount of information he left in this mailing list is here
to stay!
On a side note:
The other pull request Martin kind-of accepted was my Procedure List
search dialog for MSEide, which can be found in the 'procedurelist'
branch - but is 2 years old by now, though I still use it in my own
MSEide builds.
@Fred:
Do you have commit access to the core MSEide+MSEgui project? Or only to
MSEUniverse? Does anybody else have commit access to the MSEide+MSEgui
core project?
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
[hidden email]
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk
Locked
