On 2015-09-03 06:44, Martin Schreiber wrote:
> Thanks. Is it possible to store it in a different directory tree? I like to 
> add it to MSEuniverse doc/fpdoc:
> https://gitlab.com/mseuniverse/mseuniverse/tree/master/doc/fpdoc

Rather late than never. ;-)

I've pushed detailed instruction on using fpdoc to generate API
documentation for MSEgui. I've also included a working fpdoc project
file, and three documentation units. Later I'll had an image and code
example samples too. I'll also include my MSEide code templates that I
use when writing fpdoc style documentation.

Ideally the latest wiki based documentation, written by Michael Ebner,
should be moved to this fpdoc format too.

If Gitlab supports releases, then I can generate the latest INF docs
which you can publish as a "documentation release" - similar to what I
have done on Github:

  https://github.com/graemeg/msegui/releases


As I mentioned before, the down side of not including this in the
official MSEide+MSEgui source code repository is that you now don't have
a tight integration of this documentation relates to this MSEgui
release. Also you have to fiddle with symlinks (or copy the source
directory - Windows) so fpdoc can find the <msegui>/lib/ directory that
it needs for generating documentation.

I still strongly believe this should live in a <msegui>/docs/ directory
instead, but it's your call in the end.


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

------------------------------------------------------------------------------
Transform Data into Opportunity.
Accelerate data analysis in your applications with
Intel Data Analytics Acceleration Library.
Click to learn more.
http://pubads.g.doubleclick.net/gampad/clk?id=278785471&iu=/4140
_______________________________________________
mseide-msegui-talk mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk

Reply via email to