Watch, Follow, &
Connect with Us

QualityCentral

Public Report
Report From: Delphi for PHP/Documentation    [ Add a report in this area ]  
Report #:  43557   Status: Closed
VCL API documentation mainly useless
Project:  HTML5 Builder Build #:  414
Version:    1.0 Submitted By:   Michael Urban
Report Type:  Documentation problem Date Reported:  3/31/2007 10:30:45 AM
Severity:    Critical / Show Stopper Last Updated: 3/20/2012 2:24:39 AM
Platform:    All platforms Internal Tracking #:   258948
Resolution: Fixed (Resolution Comments) Resolved in Build: : 2.0.0.984
Duplicate of:  None
Voting and Rating
Overall Rating: (8 Total Ratings)
3.00 out of 5
Total Votes: 110
Description
Documentation like "this is member xyz of class abc" doesn't help anybody.

This auto-generated documentation is poor-poor-poor. I am used to better docs for Borland/Codegear products
Steps to Reproduce:
None
Workarounds
None
Attachment
None
Comments

Gert v.d. Venis at 4/1/2007 1:35:53 PM -
For some reason i can't seem to vote for this issue, but i TOTALLY AGREE. It's far from complete, and almost totally useless. I hope this has the topmost priority from the guys at CodeGear. Also a few descent tutorials would be nice...

Steve Zimmelman at 4/11/2007 11:37:05 AM -
Define "almost" useless...  IMO, it is useless.

Stuart Kelly at 4/1/2007 2:39:27 PM -
The online reference is better than the included help.

http://vcl4php.sourceforge.net/vcldoc/

Eric Steele at 4/3/2007 10:36:32 AM -
That's not really a viable solution.  I sometimes work from my laptop and it's not always within reach of a decent network signal.

I also was going to submit this topic.

Steven Owen at 4/5/2007 9:59:16 AM -
Codegear needs to take a look at Prado for clues on how to do documentation.

Stuart Cohen at 4/14/2007 9:20:16 PM -

For good documentation CodeGear only has to look at the Phillipe Kahn era documentation that came with Turbo Pascal, Turbo C and Turbo Assembler.  Such documentation included Turbo Tutor, A Users Guide and A Reference Guide.  Even if they put such documentation out in PDF format instead of in paper, such documentation would be great. CodeGear needs to go back to its roots as the Kahn era Borland and cater also to the new up-and-coming programmers and not just to the professionals.

Jose Leon at 4/17/2007 7:02:06 AM -
We are working on the documentation on several areas:
-VCL for PHP API documentation: embedded on the source code.
Browse:http://www.qadram.com/vcl4php/vcldoc/index.html
Download:http://www.qadram.com/vcl4php/vcldoc/vcldoc.tar.gz
-Documentation Wiki:
http://www.qadram.com/vcl4php/wiki/index.php/Main_Page

If you have specific questions about any component you can use forums:
http://www.qadram.com/vcl4php/forums/

Or mailing lists:
http://www.qadram.com/vcl4php/index.php?ac=10

What we are doing is to prioritize questions from users to fill the missing documentation and fill the wiki or the source code with it.

Klaus Kramer at 8/16/2007 4:16:26 AM -
This socalled "documentation" is absolutely annoying. Imagine yourself raising a child, which asks you why a car can move. You wouldn't say "because it does", would you? The Godegear guys want to take us for a ride??

Jose Leon at 10/17/2007 2:50:54 PM -
Documentation has been greatly enhanced, please, checkout:

http://www.qadram.com/vcl4php/vcldoc/

You can submit any request for extra documentation on the forums or in the mailing list for the project, we are continuosly updating the documentation.

Server Response from: ETNACODE01

Copyright© 1994 - 2013 Embarcadero Technologies, Inc. All rights reserved.