[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Liberty-eiffel] generating the documentation

From: Raphael Mack
Subject: Re: [Liberty-eiffel] generating the documentation
Date: Sun, 30 Mar 2014 11:07:45 +0200

Hello John,

thanks for your feedback. I just added the gc dependency for Fedora on
the Getting Started page. I guess this is not the only package required
by liberty on Fedora, could you try to provide a "full" list of packages
which are necessary?

eiffeldoc is not trivial to use, sorry for that. When you want to use
the "-prune" option to remove the boring parts of the compiler. E. g. to
generate docs only for your application, you might want to create a which points to your src files and call
eiffeldoc -prune lib -prune tools -prune smarteiffel -prune tutorial

"lib", "tools", "smarteiffel" etc. are tags from the [Loadpath]-section
in your ~/.config/liberty-eiffel/

"-verbose" helps you to find the path you want to prune to remove those
classes you are not interested in.

"-remote" may also be interesting, which allows to give an external path
to existing docs.

and you'll probably need to give a js and css file. For we use somehting like

se doc -verbose -title Section:\\ liberty -short_title liberty
-wiki_prefix -menu_separator "\\|\\ "
-ariadne_separator "\\>\\ " -menu "GNU" -menu "Liberty\\ Eiffel" -menu "Automated\\ Tests" -menu "Wiki" -menu "Savannah\\ project"
-menu "Debian\\ packages" -menu "Documentation"
-js /home/et/Liberty/resources/eiffeldoc/eiffeldoc.js
-css /home/et/Liberty/resources/eiffeldoc/eiffeldoc.css -prune test
-prune Local -remote liberty_core -remote smarteiffel -remote tutorial -remote liberty_extra

I hope this helps for the first try and feel free to suggest
improvements on eiffeldoc or even to better: provide patches ;-)

Kind regards,

Am Samstag, den 29.03.2014, 23:59 -0500 schrieb John Perry:
> Hello
> Liberty Eiffel looks really nice! I have two comments, if they interest you.
> You may want to mention on
> that, on Fedora, the gc package to install is gc-devel, rather than libgc-dev.
> More importantly, is there an efficient way to build the documentation? 
> eiffeldoc wants either an ACE file or a; I can't seem to find one 
> in the directories that doesn't decide to build documentation for the 
> compiler's source code, rather than for the libraries.
> Thanks for any help...
> john perry

reply via email to

[Prev in Thread] Current Thread [Next in Thread]