Sign in Join

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

Mailing lists / fpc-devel / 2010-12

Location of documentation

5 messages · 4 people ·

Reply by email Subscribe to this list Your subscription

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

Darius Blaszyk

I did the unthinkable ;) by trying to write some documentation for an FPC package. I searched FPC without success after which I got fpcdocs from SVN, no luck either. I only found some files included in Lazarus (\docs\xml\).

What is the plan for the lack of documentation on packages? Should I add patches for FCL documentation to Lazarus or should this be corrected and subsequently documentation should be added to the packages themselves. Mind you that there was a patch applied recently that enables documentation building from fpmake.

Regards, Darius

Reply by email

Michael Van Canneyt
to Darius Blaszyk
Darius Blaszyk wrote 10 lines
I did the unthinkable ;) by trying to write some documentation for an FPC package. I searched FPC without success after which I got fpcdocs from SVN, no luck either. I only found some files included in Lazarus (\docs\xml\). What is the plan for the lack of documentation on packages? Should I add patches for FCL documentation to Lazarus or should this be corrected and subsequently documentation should be added to the packages themselves. Mind you that there was a patch applied recently that enables documentation building from fpmake.

All FCL documentation is in

http://svn.freepascal.org/svn/fpcdocs/trunk

As for future plans: I plan to continue documenting the basic units: fcl-base, fcl-db, fcl-web, fcl-json.

Contributions are more than welcome, as long as they adhere to a strict rule: I don't publish documentation for a unit unless it is complete.

Michael.

Reply by email

Darius Blaszyk
to Michael Van Canneyt
Michael Van Canneyt wrote
Contributions are more than welcome, as long as they adhere to a strict rule: I don't publish documentation for a unit unless it is complete.

Does that mean that partial documented xml files are allowed to be added to SVN, but that they will not be published as official doc on the site? In that case, I'm ok with that. If you demand that only complete xml files are allowed in SVN than I would urge you to reconsider. Perhaps a WIP SVN repo for all I care.

Darius

Reply by email

Vincent Snijders
to Darius Blaszyk

2010/12/6 Darius Blaszyk :

Show quoted text 11 lines
On Mon, 2010-12-06 at 20:39 +0100, Michael Van Canneyt wrote: > Contributions are more than welcome, as long as they adhere to a strict > rule: I don't publish documentation for a unit unless it is complete. Does that mean that partial documented xml files are allowed to be added to SVN, but that they will not be published as official doc on the site? In that case, I'm ok with that. If you demand that only complete xml files are allowed in SVN than I would urge you to reconsider. Perhaps a WIP SVN repo for all I care.

A branch?

Vincent

Reply by email

Unknown author
to Darius Blaszyk: Does that mean that partial documented xml files are allowed to be added to SVN, but that…
Darius Blaszyk wrote 10 lines
On Mon, 2010-12-06 at 20:39 +0100, Michael Van Canneyt wrote: > Contributions are more than welcome, as long as they adhere to a strict > rule: I don't publish documentation for a unit unless it is complete. Does that mean that partial documented xml files are allowed to be added to SVN, but that they will not be published as official doc on the site? In that case, I'm ok with that. If you demand that only complete xml files are allowed in SVN than I would urge you to reconsider. Perhaps a WIP SVN repo for all I care.

They can be in SVN, that is no problem, I just won't publish them as part of the official docs till they are complete.

Michael.

Reply by email