Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / lazarus / 2003-03

documentation

7 messages · 5 people ·

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

Michael Van Canneyt
to Stefan. Hille: Just saw an announcment on freshmeat, but did not test it:…
Stefan. Hille wrote 7 lines
On Fri, Mar 07, 2003 at 12:57:40PM -0600, Jesus Reyes wrote: > Hi, do somebody knows software (apart from pasdoc) to write component > documentation? Just saw an announcment on freshmeat, but did not test it: http://fershmeat.net/projects/doxygen

It doesn't support Pascal.

1. Only does inline documentation, which makes for totally unreadable code.
2. Is written in C++, not very nice for a pascal documenter !

Michael.

Reply by email

Michael Van Canneyt
to Marco van de Voort: Hmm. Written by a Stack member though :-) Don't see such remark religiously, it is more…
Marco van de Voort wrote 13 lines
> On Mon, 10 Mar 2003, Stefan. Hille wrote: > > > On Fri, Mar 07, 2003 at 12:57:40PM -0600, Jesus Reyes wrote: > > > Hi, do somebody knows software (apart from pasdoc) to write component > > > documentation? > > > > Just saw an announcment on freshmeat, but did not test it: > > > > http://fershmeat.net/projects/doxygen > > It doesn't support Pascal. Hmm. Written by a Stack member though :-)

I know :)

Show quoted text 24 lines
> > > > and > > > > http://sourceforge.net/projects/pas2dox/ > > 1. Only does inline documentation, which makes for totally unreadable code. > 2. Is written in C++, not very nice for a pascal documenter ! Don't see such remark religiously, it is more that - It raises software limits for every day development work and usage even more. (Now all we need is LaTeX/ghostcript and rarely xfig) - It requires even more languages skills from the developpers, increasing the difficulty to keep developpers as all-round as possible on all project details. Moreover, the usual "reinvent the wheel" kind of arguments don't apply, because we have a relative concentration of expert (Object) Pascal programmers, that already maintain large amounts of Pascal code anyway. After the initial work (and fpdoc is already quite far) it is easier to extend and maintain such an own written tool, then learning ocaml to fix e.g. FPC specific bugs in doxygen, and then convince the maintainer to include the fixes.

I couldn't have said it better. In fact, I didn't :-)

Michael.

Reply by email

Marco van de Voort
to Michael Van Canneyt: It doesn't support Pascal. 1. Only does inline documentation, which makes for totally…
Show quoted text 11 lines
On Mon, 10 Mar 2003, Stefan. Hille wrote: > On Fri, Mar 07, 2003 at 12:57:40PM -0600, Jesus Reyes wrote: > > Hi, do somebody knows software (apart from pasdoc) to write component > > documentation? > > Just saw an announcment on freshmeat, but did not test it: > > http://fershmeat.net/projects/doxygen It doesn't support Pascal.

Hmm. Written by a Stack member though :-)

Show quoted text 7 lines
> > and > > http://sourceforge.net/projects/pas2dox/ 1. Only does inline documentation, which makes for totally unreadable code. 2. Is written in C++, not very nice for a pascal documenter !

Don't see such remark religiously, it is more that

- It raises software limits for every day development work and usage even more. (Now all we need is LaTeX/ghostcript and rarely xfig)
- It requires even more languages skills from the developpers, increasing the difficulty to keep developpers as all-round as possible on all project details.

Moreover, the usual "reinvent the wheel" kind of arguments don't apply, because we have a relative concentration of expert (Object) Pascal programmers, that already maintain large amounts of Pascal code anyway.

After the initial work (and fpdoc is already quite far) it is easier to extend and maintain such an own written tool, then learning ocaml to fix e.g. FPC specific bugs in doxygen, and then convince the maintainer to include the fixes.

Reply by email

Stefan. Hille
to Jesus Reyes: Hi, do somebody knows software (apart from pasdoc) to write component documentation?…
Jesus Reyes wrote
Hi, do somebody knows software (apart from pasdoc) to write component documentation?

Just saw an announcment on freshmeat, but did not test it:

http://fershmeat.net/projects/doxygen

and

http://sourceforge.net/projects/pas2dox/

bye,

Stefan

--------------------------------------------------------- Stefan Hille email: 48155 Muenster voice: 0251/664695

Reply by email

Jesus Reyes

Hi, do somebody knows software (apart from pasdoc) to write component documentation?

_________________________________________________________ Do You Yahoo!?
La mejor conexi�n a internet y 25MB extra a tu correo por $100 al mes. http://net.yahoo.com.mx

Reply by email

Jesus Reyes
to Unknown author: The 'official' FPC documentation tool is fpdoc. Check it out from cvs cvs co…

--- escribi�: >

Show quoted text 17 lines
On Fri, 7 Mar 2003, [iso-8859-1] Jesus Reyes wrote: > Hi, do somebody knows software (apart from pasdoc) to write component documentation? The 'official' FPC documentation tool is fpdoc. Check it out from cvs cvs co projects/fpdoc There is a lot of documentation, and even a GUI editing tool for it. It is ready but not yet released. I hope we'll release it soon. Michael.

Thanks, I've downloaded & compiled it looks what I'm looking for. fped is nice and easy.

regards.

Jesus Reyes.

_________________________________________________________ Do You Yahoo!?
La mejor conexi�n a internet y 25MB extra a tu correo por $100 al mes. http://net.yahoo.com.mx

Reply by email