RE: [PHP] Documentation
[snip]...[/snip] http://evolt.org/node/21173 This is an article that I wrote long ago (it needs some severe updating) that speaks to a lot of the phases of documentation. Any application typically has several audiences; developers, administrators, supporters and users are just an example of the audiences that can be involved. Each audience requires their own unique set of documentation. Hope this helps. -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] Documentation
Hello All, I finished with coding and now I am on the part when need to write documentation. But I don't know how to write correct documentation. Does have some rules or standard for writing documentation for PHP? Or maybe have some programs for writing documentations? Best Regards, Jordan JOVANOV -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
RE: [PHP] Documentation
-Original Message- From: Jordan Jovanov [mailto:jovanovj...@gmail.com] Sent: Wednesday, October 27, 2010 1:53 AM To: php-general@lists.php.net Subject: [PHP] Documentation Hello All, I finished with coding and now I am on the part when need to write documentation. But I don't know how to write correct documentation. Does have some rules or standard for writing documentation for PHP? Or maybe have some programs for writing documentations? Best Regards, Jordan JOVANOV Jordan, I believe the standard is still phpdoc.org. If you're on Windows and use phpDesigner, it has a nice built-in phpDocumentor to cover your basic documentation. I don't know about other IDEs. Regards, Tommy -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Documentation
On Oct 27, 2010, at 4:09 AM, Tommy Pham wrote: -Original Message- From: Jordan Jovanov [mailto:jovanovj...@gmail.com] Sent: Wednesday, October 27, 2010 1:53 AM To: php-general@lists.php.net Subject: [PHP] Documentation Hello All, I finished with coding and now I am on the part when need to write documentation. But I don't know how to write correct documentation. Does have some rules or standard for writing documentation for PHP? Or maybe have some programs for writing documentations? Best Regards, Jordan JOVANOV Jordan, I believe the standard is still phpdoc.org. If you're on Windows and use phpDesigner, it has a nice built-in phpDocumentor to cover your basic documentation. I don't know about other IDEs. Regards, Tommy -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php As for IDE's I have used Netbeans. It autocompletes some of the function headers for you as soon as you enter /** and hit enter, when directly above a function, method or class. The things that it will autocomplete for you are: params with names, and an @return if a return statement is present. After I use NB for putting in headers I usually use phpdoc as mentioned. Aptana has PHPDoc built into it. -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Documentation
On Wed, Oct 27, 2010 at 2:20 PM, Nicholas Kell n...@monkeyknight.comwrote: On Oct 27, 2010, at 4:09 AM, Tommy Pham wrote: -Original Message- From: Jordan Jovanov [mailto:jovanovj...@gmail.com] Sent: Wednesday, October 27, 2010 1:53 AM To: php-general@lists.php.net Subject: [PHP] Documentation Hello All, I finished with coding and now I am on the part when need to write documentation. But I don't know how to write correct documentation. Does have some rules or standard for writing documentation for PHP? Or maybe have some programs for writing documentations? Best Regards, Jordan JOVANOV Jordan, I believe the standard is still phpdoc.org. If you're on Windows and use phpDesigner, it has a nice built-in phpDocumentor to cover your basic documentation. I don't know about other IDEs. Regards, Tommy -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php As for IDE's I have used Netbeans. It autocompletes some of the function headers for you as soon as you enter /** and hit enter, when directly above a function, method or class. The things that it will autocomplete for you are: params with names, and an @return if a return statement is present. After I use NB for putting in headers I usually use phpdoc as mentioned. Aptana has PHPDoc built into it. -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php I use doxygen with eclipse. Eclipse fills automatically some fields like netbeans. Doxygen is easy to use with the GUI and once you learned to use it, you can use it for java,C++ etc...
Re: [PHP] Documentation
On Wed, 27 Oct 2010 10:52:58 +0200 Jordan Jovanov jovanovj...@gmail.com wrote: Hello All, I finished with coding and now I am on the part when need to write documentation. But I don't know how to write correct documentation. Does have some rules or standard for writing documentation for PHP? Or maybe have some programs for writing documentations? You should consider who is going to read the documentation. Are we talking about end users and/or other coders? Other coders benefit from code comments and as some suggests phpDocumentor has some nice features if you want to automate some of it. End users on the other hand need hand written documentation and in most cases non-technical explanations. Best Regards, Jordan JOVANOV -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] Browsing PHP documentation from Emacs
Hi all, I've just written a small tool for Emacs that will allow to browse PHP documentation directly from within Emacs. I thought you might be interested in it: http://aloiroberto.wordpress.com/2009/12/09/php-and-emacs-how-to-browse-documentation/ It is released with GNU GPLv3 license and it might be integrated with existing php-mode implementations. Looking forward to hear feedback from you. Regards, Roberto Aloi Twitter: @prof3ta -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Browsing PHP documentation from Emacs
Hello Roberto wrote on 2009-12-09 17:08: Hi all, I've just written a small tool for Emacs that will allow to browse PHP documentation directly from within Emacs. I thought you might be interested in it: http://aloiroberto.wordpress.com/2009/12/09/php-and-emacs-how-to-browse-documentation/ It is released with GNU GPLv3 license and it might be integrated with existing php-mode implementations. Looking forward to hear feedback from you. Interesting stuff, is this against the php.net documentation? And do you believe it would be possible to do the same from Vim? -- Take Care Kim Emax - master|minds - Vi tænker IT for dig... Konsulentbistand, programmering, design hosting af websites. http://www.masterminds.dk - http://www.emax.dk Køb din vin online på http://www.gmvin.dk -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Browsing PHP documentation from Emacs
Hi Kim, this should actually work with almost all PHP documentation pages in HTML format. I personally tested it with the English package from: http://www.php.net/download-docs.php (the one that come in many HTML files). Regards, Roberto Aloi http://aloiroberto.wordpress.com Twitter: @prof3ta -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Browsing PHP documentation from Emacs
Check the following link for help on integrating with Vim: http://vim.wikia.com/wiki/PHP_manual_in_Vim_help_format Kim Emax wrote: Hello Roberto wrote on 2009-12-09 17:08: Hi all, I've just written a small tool for Emacs that will allow to browse PHP documentation directly from within Emacs. I thought you might be interested in it: http://aloiroberto.wordpress.com/2009/12/09/php-and-emacs-how-to-browse-documentation/ It is released with GNU GPLv3 license and it might be integrated with existing php-mode implementations. Looking forward to hear feedback from you. Interesting stuff, is this against the php.net documentation? And do you believe it would be possible to do the same from Vim? -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Re: PHP documentation parsing?
On Fri, Jul 18, 2008 at 9:22 AM, Christian A. Reiter [EMAIL PROTECTED] wrote: Hi, Sorry for spamming, but i got a error reply from sending this to [EMAIL PROTECTED] Don't worry, you're not spamming, you were following up. The gods have forgiven you, so you're good to go! ;-P [EMAIL PROTECTED] is a common typo. The real address is [EMAIL PROTECTED] Note the lack of hyphen. I think it's safe to say that *most* of us have done it. I know, at least, that I have and so has Tul, just yesterday. ;-P -- /Daniel P. Brown Better prices on dedicated servers: Intel 2.4GHz/60GB/512MB/2TB $49.99/mo. Intel 3.06GHz/80GB/1GB/2TB $59.99/mo. Dedicated servers, VPS, and hosting from $2.50/mo. -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] PHP documentation parsing?
As you maybe know, the program kdevelop under Linux has a built in documentation browser which uses the online php documentation which was on the homepage of the Minnesota university. Since this homepage isn't available any more the documentation is broken. I tried to link to the new page, but the doc-browser uses an internal xml file which describes the base URL and the nodes of the manual (if you have a linux installation with kdevelop, look at the /usr/share/apps/kdevdocumentation/tocs/php.toc file). I just wanted to update the doc link, but the new page isn't in sync with the old with it's structure exactly. Could you provide me a list of the nodes of the php doc, or do I have to parse the html file (http://www.php.net/manual/en/index.php - browser html output) to convert it to a .toc file? Thank you, Chris -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] Re: PHP documentation parsing?
Christian A. Reiter wrote: As you maybe know, the program kdevelop under Linux has a built in documentation browser which uses the online php documentation which was on the homepage of the Minnesota university. Since this homepage isn't available any more the documentation is broken. I tried to link to the new page, but the doc-browser uses an internal xml file which describes the base URL and the nodes of the manual (if you have a linux installation with kdevelop, look at the /usr/share/apps/kdevdocumentation/tocs/php.toc file). I just wanted to update the doc link, but the new page isn't in sync with the old with it's structure exactly. Could you provide me a list of the nodes of the php doc, or do I have to parse the html file (http://www.php.net/manual/en/index.php - browser html output) to convert it to a .toc file? Thank you, Chris This is more of a question for the PHP Documentation Mailinglist than for php-general, so I'm cc'ing it there. Could you perhaps put up such a toc file somewhere online, so we could take a look at what it actually looks like, for those of us not having access to a kdevelop installation. Also, the php documentation on that homepage, was it just the XML-source ? or the rendered html output? I'm having a bit of a hard time figuring that out from your mail. - Tul -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] Re: PHP documentation parsing?
Am Freitag, 18. Juli 2008 13:03:43 schrieb M. Sokolewicz: This is more of a question for the PHP Documentation Mailinglist than for php-general, so I'm cc'ing it there. Could you perhaps put up such a toc file somewhere online, so we could take a look at what it actually looks like, for those of us not having access to a kdevelop installation. Also, the php documentation on that homepage, was it just the XML-source ? or the rendered html output? I'm having a bit of a hard time figuring that out from your mail. - Tul Hi, Sorry for spamming, but i got a error reply from sending this to [EMAIL PROTECTED] here is the content of the php.toc file: http://paste.ubuntu.com/28269/ I don't know exactly how the old documentation looked like (because I never saw it online) - but what I can read out of the .toc file the structure was quite the same as the one on your php.net page. The toc file describes just URLs; - one base URL (in your case www.php.net/manual/en) - all other xml nodes are titles and relative paths. I replaced the line base href=http://epoxy.mrs.umn.edu/doc/python2.2-doc/html/ with base href=http://www.php.net/manual/en/ - most of the documentation works - but not all of it, and some chapter numbers are wrong too. So I ask you if there exists a possibility to get this documentation in a format that suites better than parsing the html file op php.net ;-) Thanks, Chris -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] PHP Documentation in XML
# [EMAIL PROTECTED] / 2007-02-27 20:38:37 -0800: Does anyone know where I could find PHP Documentation in XML or in an SQL dump? In the source repository. http://www.php.net/anoncvs.php -- How many Vietnam vets does it take to screw in a light bulb? You don't know, man. You don't KNOW. Cause you weren't THERE. http://bash.org/?255991 -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] PHP Documentation in XML
Does anyone know where I could find PHP Documentation in XML or in an SQL dump? I'm trying to write an IRC bot that can retrieve information on php functions, and am realizing this would be the easiest way. Thanks in advance. -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] Documentation of PHP sourcecode
Dear all, With a growing base of previous PHP work (not to be be mistaken for a framework :) ) I also find myself recoding and reinventing the wheel. Something I really do not want to do. I am looking in some possibilities for automatically documenting my functions and classes. Preferably with some markup in the sourcecode and easy to implement. I am running Linux on my desktop so w* stuff won't do it for me :) Can anyone point me in the right direction? Thanks in advance! -- Paul R. Zwiers -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Documentation of PHP sourcecode
I am looking in some possibilities for automatically documenting my functions and classes. Preferably with some markup in the sourcecode and easy to implement. I am running Linux on my desktop so w* stuff won't do it for me :) Can anyone point me in the right direction? Check out PHPDocumentor. http://www.phpdoc.org/ This is just one package of the many that are out there. A quick search on google will show others. thnx, Chris -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Documentation of PHP sourcecode
Paul Zwiers wrote: Dear all, With a growing base of previous PHP work (not to be be mistaken for a framework :) ) I also find myself recoding and reinventing the wheel. Something I really do not want to do. I am looking in some possibilities for automatically documenting my functions and classes. Preferably with some markup in the sourcecode and easy to implement. I am running Linux on my desktop so w* stuff won't do it for me :) Can anyone point me in the right direction? Thanks in advance! http://www.phpdoc.org/ -- John C. Nichel IV Programmer/System Admin (ÜberGeek) Dot Com Holdings of Buffalo 716.856.9675 [EMAIL PROTECTED] -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Documentation of PHP sourcecode
Paul Zwiers wrote: Dear all, With a growing base of previous PHP work (not to be be mistaken for a framework :) ) I also find myself recoding and reinventing the wheel. Something I really do not want to do. I am looking in some possibilities for automatically documenting my functions and classes. Preferably with some markup in the sourcecode and easy to implement. I am running Linux on my desktop so w* stuff won't do it for me :) Can anyone point me in the right direction? google on 'phpdocumentor' - it will do exactly what your looking for (apart from write the documentation comments ;-) Thanks in advance! -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Documentation of PHP sourcecode
www.phpdoc.org similar to javadocs, and works pretty well. -Brad Paul Zwiers wrote: Dear all, With a growing base of previous PHP work (not to be be mistaken for a framework :) ) I also find myself recoding and reinventing the wheel. Something I really do not want to do. I am looking in some possibilities for automatically documenting my functions and classes. Preferably with some markup in the sourcecode and easy to implement. I am running Linux on my desktop so w* stuff won't do it for me :) Can anyone point me in the right direction? Thanks in advance! -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Documentation of PHP sourcecode
Chris Boget wrote: I am looking in some possibilities for automatically documenting my functions and classes. Preferably with some markup in the sourcecode and easy to implement. I am running Linux on my desktop so w* stuff won't do it for me :) Can anyone point me in the right direction? Check out PHPDocumentor. http://www.phpdoc.org/ This is just one package of the many that are out there. A quick search on google will show others. thnx, Chris And if you use vim - there is a plugin to automatically generate some basic documentation. http://www.vim.org/scripts/script.php?script_id=1355 -- life is a game... so have fun. -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] Documentation software
This is not a php specific question but more a programming question. I'd like to know names of software that help in creating documentation like the microsoft style of documentation when you visit the MSDN library. I can also see that often one some sites like the VBCORLIB web site. I'm sure there is something out there, i'd like mostly a web based one and open source or free obviously... Waiting for your input, thanks -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Documentation software
Mathieu Dumoulin wrote: This is not a php specific question but more a programming question. I'd oh we'll answer Q's on anything from ASP to STDs on this list ;-) like to know names of software that help in creating documentation like the microsoft style of documentation when you visit the MSDN library. I MSDN is documentation hell in terms of navigation AND content (jmho). you could try this: http://www.phpdoc.org/ note that phpDocumentor is aimed primarily at API documentation alternatively maybe this gives you a few options: http://www.google.com/search?q=php+documentation+tool can also see that often one some sites like the VBCORLIB web site. I'm sure there is something out there, i'd like mostly a web based one and open source or free obviously... Waiting for your input, thanks -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] PHP documentation solutions? (PHPDoc, Doxygen, ???)
Ok, so we're starting to get a little more serious about this product we're working on and may in the near future try to standardize and flesh out our coding and product documentation (always a nice thing). I'm semi-familiar with PHPDoc (http://www.phpdoc.org) but my boss just pointed me toward Doxygen (http://www.stack.nl/~dimitri/doxygen/) as a possible solution. Just wondering if anyone has had any practical experience with either/both or have an alternative that they enjoy using? I like the idea of being able to specify internal (developers) documentation as well as end user product documentation but maybe there's other features people have found useful as well that we havn't thought of yet. Thanks. -TG ___ Sent by ePrompter, the premier email notification software. Free download at http://www.ePrompter.com. -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
RE: [PHP] PHP documentation solutions? (PHPDoc, Doxygen, ???)
[snip] Ok, so we're starting to get a little more serious about this product we're working on and may in the near future try to standardize and flesh out our coding and product documentation (always a nice thing). I'm semi-familiar with PHPDoc (http://www.phpdoc.org) but my boss just pointed me toward Doxygen (http://www.stack.nl/~dimitri/doxygen/) as a possible solution. Just wondering if anyone has had any practical experience with either/both or have an alternative that they enjoy using? I like the idea of being able to specify internal (developers) documentation as well as end user product documentation but maybe there's other features people have found useful as well that we havn't thought of yet. [/snip] I have tried PHPdoc, but I have not tried Doxygen. After reading the features of Doxygen I would be tempted to give it a try, because I found that PHPdoc doesn't do everything that I want in an auto-doc application. I know that this is not much help. -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] PHP documentation solutions? (PHPDoc, Doxygen, ???)
On Mon, 2006-02-20 at 13:51, [EMAIL PROTECTED] wrote: Ok, so we're starting to get a little more serious about this product we're working on and may in the near future try to standardize and flesh out our coding and product documentation (always a nice thing). I'm semi-familiar with PHPDoc (http://www.phpdoc.org) but my boss just pointed me toward Doxygen (http://www.stack.nl/~dimitri/doxygen/) as a possible solution. Just wondering if anyone has had any practical experience with either/both or have an alternative that they enjoy using? I like the idea of being able to specify internal (developers) documentation as well as end user product documentation but maybe there's other features people have found useful as well that we havn't thought of yet. In the spirit of re-inventing the wheel... I rolled my own JinnDoc. I now use it to maintain my PHP and JavaScript source code documentation. Example output can be found from here: http://www.interjinn.com/jinnDoc/index.phtml Example markup can be found here (view the source): http://www.interjinn.com/javaScript/interJinn/Core/httpRequest.js Cheers, Rob. -- .. | InterJinn Application Framework - http://www.interjinn.com | :: | An application and templating framework for PHP. Boasting | | a powerful, scalable system for accessing system services | | such as forms, properties, sessions, and caches. InterJinn | | also provides an extremely flexible architecture for | | creating re-usable components quickly and easily. | `' -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
RE: [PHP] PHP documentation solutions? (PHPDoc, Doxygen, ???)
[snip] In the spirit of re-inventing the wheel... I rolled my own JinnDoc. [/snip] My single largest arguement against these kinds of tools were the additional mark-up required. Code commentary, done properly, can yield the same results without additional mark-up. I'd rather be able to insert a code comment or html comment with a simple 'type' to tell me what the commentary is. It makes it much more universal where auto-doc harvesters are concerned and removes the requirement for page level elements to be stated first, etc. example(s) /* type=description * * describe whatever is being described here */ or !-- type=description whatever is being described -- or $myBigVar = 'large' //type=variable -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
RE: [PHP] PHP documentation solutions? (PHPDoc, Doxygen, ???)
On Mon, 2006-02-20 at 15:38, Jay Blanchard wrote: [snip] In the spirit of re-inventing the wheel... I rolled my own JinnDoc. [/snip] My single largest arguement against these kinds of tools were the additional mark-up required. Code commentary, done properly, can yield the same results without additional mark-up. I'd rather be able to insert a code comment or html comment with a simple 'type' to tell me what the commentary is. It makes it much more universal where auto-doc harvesters are concerned and removes the requirement for page level elements to be stated first, etc. example(s) /* type=description * * describe whatever is being described here */ or !-- type=description whatever is being described -- or $myBigVar = 'large' //type=variable I see your point and considered it before I rolled my own, but rolling my own using the existing TemplateJinn system allowed me the flexibility of custom tags and all the goodies that already come with the TemplateJinn system making it that much easier to incorporate JinnDocs into any existing page layout scheme or whatnot and to make use of the already existing site compilation system. Also with the system you describe precision formatting becomes necessary since the parser needs to pull out implied details based on blank lines, spacing, indentation, etc... but as you also show it can make for a cleaner inline document :) Cheers, Rob. -- .. | InterJinn Application Framework - http://www.interjinn.com | :: | An application and templating framework for PHP. Boasting | | a powerful, scalable system for accessing system services | | such as forms, properties, sessions, and caches. InterJinn | | also provides an extremely flexible architecture for | | creating re-usable components quickly and easily. | `' -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
RE: [PHP] PHP documentation solutions? (PHPDoc, Doxygen, ???)
[snip] I see your point and considered it before I rolled my own, but rolling my own using the existing TemplateJinn system allowed me the flexibility of custom tags and all the goodies that already come with the TemplateJinn system making it that much easier to incorporate JinnDocs into any existing page layout scheme or whatnot and to make use of the already existing site compilation system. Also with the system you describe precision formatting becomes necessary since the parser needs to pull out implied details based on blank lines, spacing, indentation, etc... but as you also show it can make for a cleaner inline document :) [/snip] I can see where yours dovetails neatly with your InterJinn framework and agree with your take on it in this context. Where general documentability is concerned I would rather give a well defined list of comment types to my development team and roll the documentor from there. If the comment had no 'type' you could still harvest it and use it appropriately. -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] PHP documentation solutions? (PHPDoc, Doxygen, ???)
Jay Blanchard wrote: [snip] In the spirit of re-inventing the wheel... I rolled my own JinnDoc. [/snip] My single largest arguement against these kinds of tools were the additional mark-up required. Code commentary, done properly, can yield the same results without additional mark-up. I'd rather be able to insert a code comment or html comment with a simple 'type' to tell me what the commentary is. It makes it much more universal where auto-doc harvesters are concerned and removes the requirement for page level elements to be stated first, etc. example(s) /* type=description * * describe whatever is being described here */ or !-- type=description whatever is being described -- or $myBigVar = 'large' //type=variable Before each function I create, I have this: /* // Function: getCategoryEmail // Description : Retrieves a list of email addresses based on // past orders per category // Requires: $catids (Array) - Array of category ids // $id (Integer) - The DCHOB site id // Optional: None // Returns : Array with email addresses and stats; false on // failure // Author : John Nichel // Email : [EMAIL PROTECTED] // Created : 20 Mar 05 // Modified: // Modified By : // Mod Email : // Mod Date: */ Major block of code... /* // Description : Checks if customer has come in thru BorderFree; // sets appropriate flags if true // Expected: If a BorderFree id is set either in the POST or // GET request, assign id to users session so it // so that it will be available should customer // attempt to purchase. If id does not match known // BF syntax, email admin with name/value pair; set // flag for normal checkout with logging // Author : John Nichel // Email : [EMAIL PROTECTED] // Created : 20 Mar 05 // Modified: // Modified By : // Mod Email : // Mod Date: */ Variables... $foo = bar // This is what this variable is for So on, and so forth. I am the IT department here, so I'm not worried about documenting it yet. ;) -- John C. Nichel IV Programmer/System Admin (ÜberGeek) Dot Com Holdings of Buffalo 716.856.9675 [EMAIL PROTECTED] -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Documentation for VAR
I was looking for formal documentation because I am doing a pre-processor
for some PHP extensions and wanted to know the right and formal description
for it. Nevertheless, I think your examples below cover most cases, a help
much appreciated. Thanks
Satyam
Jochem Maas [EMAIL PROTECTED] wrote in message
news:[EMAIL PROTECTED]
Richard Davey wrote:
Hello Satyam,
Friday, April 22, 2005, 3:59:38 PM, you wrote:
S I've been going through the manual and haven't found 'var'
S documented anywhere, as far as I found, it is just used, and that's
S it. It seems it first appears when it talks about Classes, and it
S is just used in the examples as if everyone knew what var is
S supposed to do.
It's a constant initializer - which is both an accurate and
misleading title at the same time :) It will initialise a variable to
be constant through-out your entire class (meaning any method can
access it) but unlike true PHP constants (those created with define)
the value of the variable can be manipulated from just about anywhere.
indeed in php you can do the following instead:
?
error_reporting( E_ALL E_STRICT );
class Test
{
// this first var (commented out) should (I thought) act as if defined
// 'public' - it doesn't given a parse error with php -l, but does
when run.
// I haven't run into this problem in 1.5 years of writing php5...
// I must be having a brain freeze :-/
//$myVar;
// publically accessible instances variables
public $myVar1; // not initialized with a value
public $myVar2 = 2; // initialized with a value
// an instance variable thats only available
// from within _all_ methods of this object.
// .. methods could be defined in subclasses or parent-classes
protected $myVar3 = 3;
// an instance variable that is only available to the
// methods defined in _this_ class
private $myVar4 = 4;
// a variable with class scope (all instances see the same value),
// publically accessible
static $myVar5 = 5;
static public $myVar6 = 6;
// a variable with class scope (all instances see the same value),
// thats only available from within _all_ methods of this object.
static protected $myVar7 = 7;
// a variable with class scope (all instances see the same value),
// thats only available from methods defined in _this_ class
static private $myVar8 = 8;
public function get4() { return $this-myVar4; }
public function get8() { return self::$myVar8; }
}
// basic usage examples:
var_dump( ($t = new Test), $t-myVar2, $t-get4(), Test::$myVar6,
$t-get8() );
?
I can thoroughly recommend php5's much improved object model,
try other variations of calls to the defined 'myVar's, also try doing
with sublcasses, see what does/doesn't work, have fun :-)
It is of course PHP4 only and is depreciated in PHP5.
Best regards,
Richard Davey
--
PHP General Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] Documentation for VAR
I've been going through the manual and haven't found 'var' documented anywhere, as far as I found, it is just used, and that's it. It seems it first appears when it talks about Classes, and it is just used in the examples as if everyone knew what var is supposed to do. Thanks Satyam -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
RE: [PHP] Documentation for VAR
[snip] I've been going through the manual and haven't found 'var' documented anywhere, as far as I found, it is just used, and that's it. It seems it first appears when it talks about Classes, and it is just used in the examples as if everyone knew what var is supposed to do. [/snip] It is just a variable name. -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Documentation for VAR
Hello Satyam, Friday, April 22, 2005, 3:59:38 PM, you wrote: S I've been going through the manual and haven't found 'var' S documented anywhere, as far as I found, it is just used, and that's S it. It seems it first appears when it talks about Classes, and it S is just used in the examples as if everyone knew what var is S supposed to do. It's a constant initializer - which is both an accurate and misleading title at the same time :) It will initialise a variable to be constant through-out your entire class (meaning any method can access it) but unlike true PHP constants (those created with define) the value of the variable can be manipulated from just about anywhere. It is of course PHP4 only and is depreciated in PHP5. Best regards, Richard Davey -- http://www.launchcode.co.uk - PHP Development Services I do not fear computers. I fear the lack of them. - Isaac Asimov -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Documentation for VAR
Richard Davey wrote:
Hello Satyam,
Friday, April 22, 2005, 3:59:38 PM, you wrote:
S I've been going through the manual and haven't found 'var'
S documented anywhere, as far as I found, it is just used, and that's
S it. It seems it first appears when it talks about Classes, and it
S is just used in the examples as if everyone knew what var is
S supposed to do.
It's a constant initializer - which is both an accurate and
misleading title at the same time :) It will initialise a variable to
be constant through-out your entire class (meaning any method can
access it) but unlike true PHP constants (those created with define)
the value of the variable can be manipulated from just about anywhere.
indeed in php you can do the following instead:
?
error_reporting( E_ALL E_STRICT );
class Test
{
// this first var (commented out) should (I thought) act as if defined
// 'public' - it doesn't given a parse error with php -l, but does when run.
// I haven't run into this problem in 1.5 years of writing php5...
// I must be having a brain freeze :-/
//$myVar;
// publically accessible instances variables
public $myVar1; // not initialized with a value
public $myVar2 = 2; // initialized with a value
// an instance variable thats only available
// from within _all_ methods of this object.
// .. methods could be defined in subclasses or parent-classes
protected $myVar3 = 3;
// an instance variable that is only available to the
// methods defined in _this_ class
private $myVar4 = 4;
// a variable with class scope (all instances see the same value),
// publically accessible
static $myVar5 = 5;
static public $myVar6 = 6;
// a variable with class scope (all instances see the same value),
// thats only available from within _all_ methods of this object.
static protected $myVar7 = 7;
// a variable with class scope (all instances see the same value),
// thats only available from methods defined in _this_ class
static private $myVar8 = 8;
public function get4() { return $this-myVar4; }
public function get8() { return self::$myVar8; }
}
// basic usage examples:
var_dump( ($t = new Test), $t-myVar2, $t-get4(), Test::$myVar6, $t-get8() );
?
I can thoroughly recommend php5's much improved object model,
try other variations of calls to the defined 'myVar's, also try doing
with sublcasses, see what does/doesn't work, have fun :-)
It is of course PHP4 only and is depreciated in PHP5.
Best regards,
Richard Davey
--
PHP General Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] Documentation on features not in current release (SimpleXML PHP5 Beta 3)
--- Jonathan [EMAIL PROTECTED] wrote: Where would I be able to find a function reference or documentation on new features that are not documented in the official manual? Usually nowhere. Features that have yet to be documented are probably so experimental, new, unfinished, or whatever, that documentation written now would be wrong by the time those features are stable. However, if you're just wanting to learn more about SimpleXML specifically, Adam wrote a nice article about it yesterday. You can find it here: http://www.onlamp.com/pub/a/php/2004/01/15/simplexml.html Hope that helps. Chris = Chris Shiflett - http://shiflett.org/ PHP Security Handbook Coming mid-2004 HTTP Developer's Handbook http://httphandbook.org/ -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] Documentation on features not in current release (SimpleXML PHP5 Beta 3)
Where would I be able to find a function reference or documentation on new features that are not documented in the official manual? Preferably in a format that can be read/browsed offline. Thanks, Jonathan P.S. Sorry if this is a repeat, I thought this went through but just got a bounce back. -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] Documentation on features not in current release (SimpleXML PHP5 Beta 3)
Where would I be able to find a function reference or documentation on new features that are not documented in the official manual? Preferably in a format that can be read/browsed offline. Thanks, Jonathan -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] PHP Documentation procedure
Is there any utility that can be run against a php script to generate documentation of the functions in that script? Sort of like javadoc is for java code thanks Ahbaid -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] PHP Documentation procedure
On Wed, Nov 05, 2003 at 10:42:02AM -0600, Ahbaid Gaffoor wrote: Is there any utility that can be run against a php script to generate documentation of the functions in that script? Sort of like javadoc is for java code http://www.phpdoc.de/ http://phpdocu.sourceforge.net/ -- zhuravlev alexander u l s t u n o c ([EMAIL PROTECTED]) -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] PHP Documentation procedure
Ahbaid Gaffoor wrote: Is there any utility that can be run against a php script to generate documentation of the functions in that script? Sort of like javadoc is for java code Why do you mean phpdocumentor? http://pear.php.net/package/PhpDocumentor The phpDocumentor tool is a standalone auto-documentor similar to JavaDoc written in PHP. There is also a phpdoc iirc. -- Burhan Khalid phplist[at]meidomus[dot]com http://www.meidomus.com -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] PHP Documentation procedure
http://phpdocu.sourceforge.net/ http://www.callowayprints.com/phpdoc/ http://sourceforge.net/projects/phpdocu/ http://www.stack.nl/~dimitri/doxygen/ Ahbaid Gaffoor wrote: Is there any utility that can be run against a php script to generate documentation of the functions in that script? Sort of like javadoc is for java code thanks Ahbaid -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] PHP Documentation procedure
Thank you! Just what I needed. Ahbaid Boyan Nedkov wrote: http://phpdocu.sourceforge.net/ http://www.callowayprints.com/phpdoc/ http://sourceforge.net/projects/phpdocu/ http://www.stack.nl/~dimitri/doxygen/ Ahbaid Gaffoor wrote: Is there any utility that can be run against a php script to generate documentation of the functions in that script? Sort of like javadoc is for java code thanks Ahbaid -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] documentation on
Can someone point me to documentation on the operator? I am wondering if there are some quirks I don't know about. Yet I can't find it documented on the php website. THanks, Rich -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] documentation on
On Wed, Oct 01, 2003 at 01:07:35PM -0400, Rich Fox wrote: : : Can someone point me to documentation on the operator? I am wondering if : there are some quirks I don't know about. Yet I can't find it documented on : the php website. Try searching for heredoc. -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
RE: [PHP] documentation on
Rich Fox mailto:[EMAIL PROTECTED] on Wednesday, October 01, 2003 10:08 AM said: Can someone point me to documentation on the operator? I am wondering if there are some quirks I don't know about. Yet I can't find it documented on the php website. I don't know the answer to your question but... notsarcasticDid you know that it's called the heredoc operator? You may be able to find information if you search google for heredoc php and/or heredoc operator php./notsarcastic hth, Chris. -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] documentation on pg_escape_string()
Anyone know where to find documentation on this? Who knows what it escapes? please cc / bc me as I'm on digest -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
Re: [PHP] documentation on pg_escape_string()
Dennis Gearon wrote: Anyone know where to find documentation on this? Who knows what it escapes? From PostgreSQL source (~/pgsql/src/interfaces/libpq/fe-exec.c): 8 /* --- * Escaping arbitrary strings to get valid SQL strings/identifiers. * * Replaces \\ with and ' with ''. * length is the length of the buffer pointed to by * from. The buffer at to must be at least 2*length + 1 characters * long. A terminating NUL character is written. * --- */ size_t PQescapeString(char *to, const char *from, size_t length) 8 I presume the PHP function is just a wrapper around this one (but did not actually check). HTH, Joe -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
RE: [PHP] documentation on pg_escape_string()
Anyone know where to find documentation on this? Who knows what it escapes? I always look in the manual when I'm looking for documentation, but that's just me. Hell, call me crazy, but I'd probably look in the chapter on the PG functions... but that's just me... and I have no idea what I'm doing. ---John W. Holmes... PHP Architect - A monthly magazine for PHP Professionals. Get your copy today. http://www.phparch.com/ -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] Documentation Help
Hi Everyone, I worked on educational intranet and library management system. I did comment my code but i dont know how to document functional and technical specification as well as database schema. Can anyone help me how to start working on documentation part so other developer can easily understand of these massive projects. Thanks and really appreciate if someone can help me Hardik - Do you Yahoo!? Yahoo! Mail Plus - Powerful. Affordable. Sign up now
RE: [PHP] Documentation Help
Hi Hardik, I worked on educational intranet and library management system. I did comment my code but i dont know how to document functional and technical specification as well as database schema. Theoretically, you should write the specs before the program (that way, the program matches the specs, not the other way round) Looks like it's too late for that now though :-) Here's a good article on writing functional specs (part 1 of 4): http://joelonsoftware.com/articles/fog36.html Cheers Jon -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] documentation comment
not to start a war, but have you seen php.net's documentation compared to anything microsoft or anyone else has ever put out? i'd say that documentation is microsoft's achilles heel -- PHP General Mailing List (http://www.php.net/) To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] To contact the list administrators, e-mail: [EMAIL PROTECTED]
Re: [PHP] documentation comment
Have you seen a MSDN subscription latly? Its many many CDs of Help Files and such... Php.net has comments added by coders on the end, but other than that they have nothing over M$ unless i'm missing something? Andrew - Original Message - From: Jack Dempsey [EMAIL PROTECTED] To: [EMAIL PROTECTED] Sent: Sunday, November 04, 2001 7:59 PM Subject: [PHP] documentation comment not to start a war, but have you seen php.net's documentation compared to anything microsoft or anyone else has ever put out? i'd say that documentation is microsoft's achilles heel -- PHP General Mailing List (http://www.php.net/) To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] To contact the list administrators, e-mail: [EMAIL PROTECTED] -- PHP General Mailing List (http://www.php.net/) To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] To contact the list administrators, e-mail: [EMAIL PROTECTED]
RE: [PHP] documentation comment
I would have to agree on a global scale. However, strictly in discussion of server-side languages, I haven't seen ASP documentation as complete/useful as PHP's... I have never had to use anything besides the PHP manual to solve a problem in writing something. -Original Message- From: Andrew Brampton [mailto:[EMAIL PROTECTED]] Sent: Sunday, November 04, 2001 5:46 PM To: [EMAIL PROTECTED] Subject: Re: [PHP] documentation comment Have you seen a MSDN subscription latly? Its many many CDs of Help Files and such... Php.net has comments added by coders on the end, but other than that they have nothing over M$ unless i'm missing something? Andrew - Original Message - From: Jack Dempsey [EMAIL PROTECTED] To: [EMAIL PROTECTED] Sent: Sunday, November 04, 2001 7:59 PM Subject: [PHP] documentation comment not to start a war, but have you seen php.net's documentation compared to anything microsoft or anyone else has ever put out? i'd say that documentation is microsoft's achilles heel -- PHP General Mailing List (http://www.php.net/) To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] To contact the list administrators, e-mail: [EMAIL PROTECTED] -- PHP General Mailing List (http://www.php.net/) To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] To contact the list administrators, e-mail: [EMAIL PROTECTED] -- PHP General Mailing List (http://www.php.net/) To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] To contact the list administrators, e-mail: [EMAIL PROTECTED]
[PHP] Documentation for snapshot releases?
Hi - Is it possible to get documentation for the snapshopt releases? Or something newer than 4.0.6? All pointers appreciated. Thanks! -philip -- PHP General Mailing List (http://www.php.net/) To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] To contact the list administrators, e-mail: [EMAIL PROTECTED]
[PHP] Documentation
Does anyone know alternative sites for PHP documentation? www.php.net seems to be down. Thankls, Don -- PHP General Mailing List (http://www.php.net/) To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] To contact the list administrators, e-mail: [EMAIL PROTECTED]
Re: [PHP] Documentation
http://uk.php.net/mirrors.php regards, philip On Fri, 11 May 2001, Don Pro wrote: Does anyone know alternative sites for PHP documentation? www.php.net seems to be down. Thankls, Don -- PHP General Mailing List (http://www.php.net/) To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] To contact the list administrators, e-mail: [EMAIL PROTECTED] -- PHP General Mailing List (http://www.php.net/) To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] To contact the list administrators, e-mail: [EMAIL PROTECTED]
RE: [PHP] Documentation
I hate the fact that php.net, phpbuilder.com are down very frequently and mysql.com is slow usually.. It's too bad for our image. Oktay Altunergil -Original Message- From: Philip Olson [mailto:[EMAIL PROTECTED]] Sent: Friday, May 11, 2001 1:26 PM To: Don Pro Cc: php list Subject: Re: [PHP] Documentation http://uk.php.net/mirrors.php regards, philip On Fri, 11 May 2001, Don Pro wrote: Does anyone know alternative sites for PHP documentation? www.php.net seems to be down. Thankls, Don -- PHP General Mailing List (http://www.php.net/) To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] To contact the list administrators, e-mail: [EMAIL PROTECTED] -- PHP General Mailing List (http://www.php.net/) To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] To contact the list administrators, e-mail: [EMAIL PROTECTED] -- PHP General Mailing List (http://www.php.net/) To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] To contact the list administrators, e-mail: [EMAIL PROTECTED]
[PHP] JavaScript/PHP documentation
Hello, I have noticed that while the JavaScript/PHP documentation looks much nicer only an HTML version of the PHP documentaion is distributed. I would like to know whether it would be possible to obtain the original much more pleasant to read JavaScript/PHP documentation so that users may install a copy on their local hard drive and browse the pretty documentation while offline. Thanks, Neil -- PHP General Mailing List (http://www.php.net/) To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] To contact the list administrators, e-mail: [EMAIL PROTECTED]
