Hardline
Posts: 24
|
| Posted: 01/29/2010, 5:59 AM |
|
A simple request: CodeCharge's class and functions API documentation.
There really are quite a few time-saving functions in Common.php and Services.php that I know are being over-looked by several CodeCharge developers and because of that, CodeCharge isn't given the credit it's truly deserved.
A simple, phpDoc style reference that shows the function name, the class in which it's defined, it's parameters and what it returns is all that's needed.
|
 |
 |
datadoit
|
| Posted: 02/01/2010, 1:12 PM |
|
Did a little evaluation of those files, and find that of 82 functions,
only 18 are actually documented in the help files!
You are correct - there are a gozillion great little functions that are
available that will help to speed up development time even more.
Additionally, using more and more of these built-in functions keep your
applications easily portable to other languages and platforms (less
custom coding).
I've posted a prototype for a community wiki:
http://wiki.codechargesupport.com. See the Functions section
(http://wiki.codechargesupport.com/index.php/Programming_Reference:Functions)
to see what I'm talking about above.
I'll get the navigation and structure hashed out (including multiple
languages), then open up to other contributors to help -fill in the
blanks- as time permits.
If we wait on Yes Software to update documentation, we're moving
backwards. Besides, this will hopefully keep them focused on
stabilizing and improving an otherwise great application.
|
|
|
|
Hardline
Posts: 24
|
| Posted: 02/09/2010, 6:31 AM |
|
Quote datadoit:
Did a little evaluation of those files, and find that of 82 functions,
only 18 are actually documented in the help files!
Ridiculous isn't it?! All my CS professors in college did say that the hardest thing for all programmers to do is to write good documentation, and that's only when they actually motivate themselves to write documentation in the first place.
Quote datadoit:
I've posted a prototype for a community wiki: http://wiki.codechargesupport.com. See the Functions section
(http://wiki.codechargesupport.com/index.php/Programming_Reference:Functions)
to see what I'm talking about above.
Nice! Looks great and is easy to read. Although it's a prototype I've bookmarked this. A wiki is definitely the way to go, good call.
I have another question, do you have any idea what the class clsQuadraticPaths is used for? It's on line 2751 of Classes.php. I doubt I'd ever need this, but I'd like to at least know what it does and what CodeCharge uses it for. My guess is it's used for building menus.
|
|
|
|
datadoit
|
| Posted: 02/09/2010, 7:07 AM |
|
Hardline wrote:
> I have another question, do you have any idea what the class clsQuadraticPaths
> is used for? It's on like 2751 of Classes.php. I'm not sure if I'd ever need
> this, but I'd like to at least know what it does.
> ---------------------------------------
It's used for the Captcha component. Who woulda thunk it huh? :)
|
|
|
|
mamboBROWN
Posts: 1713
|
| Posted: 02/10/2010, 1:19 PM |
|
datadoit
Your CodeCharge Studio Community Wiki is a great reference for the CCS community. Hopefully CCSers will make use of it. I have been fortunate to have used a few of the functions myself.
|
|
|
|
|
