On Monday 01/09/2014 at 14:04, Patrick Goupell wrote:
>
> On 08/20/2014 05:40 PM, Graeme Geldenhuys wrote:
>>
>>
>> May I also suggest you use fpdoc's XML format for documentation. That
>> way you can use it to further generated HTML, PDF, CHM, INF, MAN
>> pages,
>> TXT etc help text.
>>
>> The little bit of MSEgui documentation I have seen was just some
>> random
>> scattered text and topics in a single TXT file. You can't do anything
>> with that!
>>
>>
>
> I am trying to figure out fpdoc.
>
> If I run the fpdoc command with --format=xml what do I then do with
> the
> xml file to get html/pdf/etc files?
I could never figure out the purpose of "--format=xml". I have only
used the output formats: chm, html, ipf, rtf, txt
Best would be to read the fpdoc documentation:
http://freepascal.org/docs.var
See the "fpdoc documentation tool reference manual" links. Basically
you create a XML file that contains the help text describing
everything about the related *.pas unit. Normally one XML file for one
.pas file (but this is not a hard rule). You don't need to document
everything or create a "skeleton xml file". You can start small, for
example by adding a description for each *.pas file you document. Then
build up the documentation from there.
The latest fpdoc supports project files, which is MUCH easier than the
massive command line parameters one used to use. See my recent posts
here for links and examples of usage.
Regards,
- Graeme -
--
fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal
http://fpgui.sourceforge.net/
------------------------------------------------------------------------------
Slashdot TV.
Video for Nerds. Stuff that matters.
http://tv.slashdot.org/
_______________________________________________
mseide-msegui-talk mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk
