RE: [PHP] Documentation

2010-10-28 Thread Jay Blanchard
[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 a

Re: [PHP] Documentation

2010-10-27 Thread Rico Secada
On Wed, 27 Oct 2010 10:52:58 +0200 Jordan Jovanov 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 hav

Re: [PHP] Documentation

2010-10-27 Thread Teto
On Wed, Oct 27, 2010 at 2:20 PM, Nicholas Kell wrote: > > 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:

Re: [PHP] Documentation

2010-10-27 Thread Nicholas Kell
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 >> >> He

RE: [PHP] Documentation

2010-10-27 Thread Tommy Pham
> -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

[PHP] Documentation

2010-10-27 Thread Jordan Jovanov
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 JOV

Re: [PHP] Browsing PHP documentation from Emacs

2009-12-09 Thread Joseph Thayne
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 w

Re: [PHP] Browsing PHP documentation from Emacs

2009-12-09 Thread Roberto
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

Re: [PHP] Browsing PHP documentation from Emacs

2009-12-09 Thread Kim Emax
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

[PHP] Browsing PHP documentation from Emacs

2009-12-09 Thread Roberto
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 a

Re: [PHP] Re: PHP documentation parsing?

2008-07-19 Thread Daniel Brown
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

[PHP] Re: PHP documentation parsing?

2008-07-18 Thread Christian A. Reiter
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

[PHP] Re: PHP documentation parsing?

2008-07-18 Thread M. Sokolewicz
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

[PHP] PHP documentation parsing?

2008-07-18 Thread Christian A. Reiter
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 th

Re: [PHP] PHP Documentation in XML

2007-02-28 Thread Roman Neuhauser
# [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

[PHP] PHP Documentation in XML

2007-02-27 Thread Matt Carlson
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 unsubs

Re: [PHP] Documentation of PHP sourcecode

2006-08-02 Thread Ligaya Turmelle
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? C

Re: [PHP] Documentation of PHP sourcecode

2006-08-02 Thread Brad Bonkoski
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 s

Re: [PHP] Documentation of PHP sourcecode

2006-08-02 Thread Jochem Maas
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 func

Re: [PHP] Documentation of PHP sourcecode

2006-08-02 Thread John Nichel
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

Re: [PHP] Documentation of PHP sourcecode

2006-08-02 Thread Chris Boget
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 PHPDocumento

[PHP] Documentation of PHP sourcecode

2006-08-02 Thread Paul Zwiers
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 wi

Re: [PHP] Documentation software

2006-06-29 Thread Jochem Maas
ation 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?

[PHP] Documentation software

2006-06-29 Thread Mathieu Dumoulin
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 t

Re: [PHP] PHP documentation solutions? (PHPDoc, Doxygen, ???)

2006-02-20 Thread John Nichel
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 rathe

RE: [PHP] PHP documentation solutions? (PHPDoc, Doxygen, ???)

2006-02-20 Thread Jay Blanchard
[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 existi

RE: [PHP] PHP documentation solutions? (PHPDoc, Doxygen, ???)

2006-02-20 Thread Robert Cummings
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 > resu

RE: [PHP] PHP documentation solutions? (PHPDoc, Doxygen, ???)

2006-02-20 Thread Jay Blanchard
[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 c

Re: [PHP] PHP documentation solutions? (PHPDoc, Doxygen, ???)

2006-02-20 Thread Robert Cummings
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 PH

RE: [PHP] PHP documentation solutions? (PHPDoc, Doxygen, ???)

2006-02-20 Thread Jay Blanchard
[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 t

[PHP] PHP documentation solutions? (PHPDoc, Doxygen, ???)

2006-02-20 Thread tg-php
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 towar

Re: [PHP] Documentation for VAR

2005-04-23 Thread Richard Davey
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

RE: [PHP] Documentation for VAR

2005-04-23 Thread Jay Blanchard
[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 jus

[PHP] Documentation for VAR

2005-04-23 Thread Satyam
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

Re: [PHP] Documentation for VAR

2005-04-23 Thread Satyam
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]>

Re: [PHP] Documentation for VAR

2005-04-22 Thread Jochem Maas
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

Re: [PHP] Documentation on features not in current release (SimpleXML PHP5 Beta 3)

2004-01-17 Thread Chris Shiflett
--- 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

[PHP] Documentation on features not in current release (SimpleXML PHP5 Beta 3)

2004-01-16 Thread Jonathan
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. -- P

[PHP] Documentation on features not in current release (SimpleXML PHP5 Beta 3)

2004-01-13 Thread Jonathan
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.

Re: [PHP] PHP Documentation procedure

2003-11-05 Thread Ahbaid Gaffoor
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

Re: [PHP] PHP Documentation procedure

2003-11-05 Thread Boyan Nedkov
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

Re: [PHP] PHP Documentation procedure

2003-11-05 Thread Burhan Khalid
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 a

Re: [PHP] PHP Documentation procedure

2003-11-05 Thread zhuravlev alexander
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.

[PHP] PHP Documentation procedure

2003-11-05 Thread Ahbaid Gaffoor
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] documentation on "<<<"

2003-10-01 Thread Chris W. Parker
Rich Fox 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 que

Re: [PHP] documentation on "<<<"

2003-10-01 Thread Eugene Lee
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 (h

[PHP] documentation on "<<<"

2003-10-01 Thread Rich Fox
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 pg_escape_string()

2003-03-17 Thread John W. Holmes
> 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 doi

Re: [PHP] documentation on pg_escape_string()

2003-03-17 Thread Joe Conway
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 SQ

[PHP] documentation on pg_escape_string()

2003-03-17 Thread Dennis Gearon
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 Help

2003-02-05 Thread Jon Haworth
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

[PHP] Documentation Help

2003-02-05 Thread Hardik Doshi
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 unde

RE: [PHP] documentation comment

2001-11-04 Thread Matthew Loff
- 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

Re: [PHP] documentation comment

2001-11-04 Thread Andrew Brampton
AIL 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 &

[PHP] documentation comment

2001-11-04 Thread Jack Dempsey
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 co

[PHP] Documentation for snapshot releases?

2001-08-30 Thread Philip Hallstrom
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]

RE: [PHP] Documentation

2001-05-11 Thread Altunergil, Oktay
t: 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 Mail

Re: [PHP] Documentation

2001-05-11 Thread Philip Olson
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.

[PHP] Documentation

2001-05-11 Thread Don Pro
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

Re: [PHP] JavaScript/PHP documentation

2001-01-11 Thread Richard Lynch
thing with PHP and database and all -- Not sure what the current legalities of either of those options are. - Original Message - From: Neil Zanella <[EMAIL PROTECTED]> Newsgroups: php.general Sent: Thursday, January 11, 2001 1:48 PM Subject: [PHP] JavaScript/PHP documentation > >

[PHP] JavaScript/PHP documentation

2001-01-11 Thread Neil Zanella
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