Sign in Join

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

Mailing lists / lazarus / 2012-12

fpdoc enhanced - call for tests

6 messages · 3 people ·

Reply by email Subscribe to this list Your subscription

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

Michael Van Canneyt

Hi,

I have enhanced fpdoc.
It now creates a (clickable) hierarchy of the classes in the package that is documented.

A sample of what it will look like is available at

http://www.freepascal.org/docs-html/rtl/index-9.html http://www.freepascal.org/docs-html/fcl/index-9.html

The tree can be expanded/collapsed for easy navigation, if your browser supports javascript. (if not, nothing will happen).

I'd like people to test and report their findings.

There is still one known issue: references to classes in a separate package which were imported through the --import clause, are not yet correctly rendered.

(as visible in http://www.freepascal.org/docs-html/fcl/index-9.html)

Michael.

Reply by email

Vincent Snijders
to Michael Van Canneyt

2012/12/20 Michael Van Canneyt :

Show quoted text 6 lines
Hi, I have enhanced fpdoc. It now creates a (clickable) hierarchy of the classes in the package that is documented.

Is this related to the fpdoc build failure:
make[3]: Entering directory
`/var/lib/jenkins/workspace/buildfpc_branch/platform/i386-linux/fpc/trunk/utils/fpdoc' ../bin2obj -o css.inc -c DefaultCSS fpdoc.css
make[3]: *** No rule to make target `images/plus.png', needed by `plusimage.inc'. Stop.

Full log at:
https://fpcbuildserver.firmos.at/job/buildfpc_branch/platform=i386-linux/128/console

Vincent

Reply by email

Michael Van Canneyt
to Vincent Snijders
Vincent Snijders wrote 14 lines
2012/12/20 Michael Van Canneyt : > > Hi, > > I have enhanced fpdoc. It now creates a (clickable) hierarchy of the classes > in the package that is documented. > Is this related to the fpdoc build failure: make[3]: Entering directory `/var/lib/jenkins/workspace/buildfpc_branch/platform/i386-linux/fpc/trunk/utils/fpdoc' ../bin2obj -o css.inc -c DefaultCSS fpdoc.css make[3]: *** No rule to make target `images/plus.png', needed by `plusimage.inc'. Stop.

Yep. Forgot to commit some files:
Fixed in rev. 23196.

Michael.

Reply by email

Vincent Snijders
to Michael Van Canneyt: I have enhanced fpdoc. It now creates a (clickable) hierarchy of the classes in the…

2012/12/20 Michael Van Canneyt :

Show quoted text 9 lines
Hi, I have enhanced fpdoc. It now creates a (clickable) hierarchy of the classes in the package that is documented. A sample of what it will look like is available at http://www.freepascal.org/docs-html/rtl/index-9.html

Will a link to this page also appear on
http://www.freepascal.org/docs-html/rtl/index.html , id the new fpdoc is used to compile the RTL docs?

Vincent

Reply by email

Michael Van Canneyt
to Vincent Snijders: 2012/12/20 Michael Van Canneyt : Will a link to this page also appear on…
Vincent Snijders wrote 14 lines
2012/12/20 Michael Van Canneyt : > > Hi, > > I have enhanced fpdoc. It now creates a (clickable) hierarchy of the classes > in the package that is documented. > > A sample of what it will look like is available at > > http://www.freepascal.org/docs-html/rtl/index-9.html Will a link to this page also appear on http://www.freepascal.org/docs-html/rtl/index.html , id the new fpdoc is used to compile the RTL docs?

The link will be there as soon as the new fpdoc is used to create the docs. I just put this one up for demonstration purposes.

Michael.

Reply by email