<br><br><div class="gmail_quote">On 28 February 2012 18:43, Marc Santhoff <span dir="ltr"><<a href="mailto:M.Santhoff@web.de">M.Santhoff@web.de</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Hi again,<br>
<br>
since there were multiple complaints about missing documentation, where<br>
can I find a list of what is missing exactly in detail?<br>
<br>
Is there a wiki page about it? Or a docs page collecting empty<br>
descriptions or the like?<br>
<br>
Sometimes I'm bored, maybe there are items I'm able to add<br>
a couple of useful words to ...<br>
<br>
TIA,<br>
Marc<br>
<span class="HOEnZb"><font color="#888888">--<br>
Marc Santhoff <<a href="mailto:M.Santhoff@web.de">M.Santhoff@web.de</a>><br>
<br>
<br>
--<br>
_______________________________________________<br>
Lazarus mailing list<br>
<a href="mailto:Lazarus@lists.lazarus.freepascal.org">Lazarus@lists.lazarus.freepascal.org</a><br>
<a href="http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus" target="_blank">http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus</a><br>
</font></span></blockquote></div><br>I asked this question in the FPC mailing list a few hours ago, and I am here to ask the same question about Lazarus. Hopefully I won't press the Send button in Gmail before I finish.<br>
<br>It is becoming obvious as shown in this thread that good documentation about Lazarus Documentation and more importantly the process, tools and procedures by which it is generated is lacking and that together with some documentation about how the Lazarus project itself is organized is necessary before any meaningful and friction free progress can be made. I have thought about starting a new thread but this one seems as good as any.<br clear="all">
<br><br><br>1. Are they created by a tool or hand edited? what are the tools used?<br><br>2. Is there some page where the original docs are created?<br><br>3. Are they text files that are stored under version control?<br>
<br>4. Is there some page where previous versions are available?<br><br>5. How is it structured, what are the formatting rules? Is based on standards like DocBook etc?<br>
<br>6. How much of the documentation is generated from the source code? Is information about input and output parameters, and a few lines about its usage and gotchas generated from source, or does all procedures need to be documented by hand using FPDoc? Graeme mentions IPF that in his view does a better job?  Do other preferably Pascal based projects use other tools with which they have had more success?<br>
<br>7. Are there other tools that can do a better job, such as Jira, Github etc?<br><br>8. I assume that docs are generated by some build tool once created. Does the submitter compile the docs on their own system and test that they are fine before getting them committed into the repository? Are the tools used identical (I see messages in the mailing list about contributors being using different versions of the tools)?<br>
<br>I guess these are the questions I want to ask.<br><br><br><br>-- <br>Frank Church<br><br>=======================<br><a href="http://devblog.brahmancreations.com">http://devblog.brahmancreations.com</a><br>