Re: [PHP-DOC] phpdoc conventions on methods

2007-08-16 Thread Philip Olson
You could send a file, or two, to the list and have people check it out for you... Thanks, the docs I'm talking about are in http://cvs.php.net/viewvc.cgi/pecl/intl/doc/intl/ I don't have the time to check it out at the moment, hopefully someone else will :] Looks pretty good so far, but a

Re: [PHP-DOC] phpdoc conventions on methods

2007-08-16 Thread Hannes Magnusson
On 8/17/07, Stanislav Malyshev <[EMAIL PROTECTED]> wrote: > > This magic include has nothing to do with IDs or refnames or any other > > element/attribute. Its a total file based voodoo. > > Yes, I understand. What I wasn't sure is if I have two refname's in > refentry tag, would I still get one en

Re: [PHP-DOC] phpdoc conventions on methods

2007-08-16 Thread Stanislav Malyshev
This magic include has nothing to do with IDs or refnames or any other element/attribute. Its a total file based voodoo. Yes, I understand. What I wasn't sure is if I have two refname's in refentry tag, would I still get one entry on the reference page when it's rendered? I guess the answer is

Re: [PHP-DOC] phpdoc conventions on methods

2007-08-16 Thread Hannes Magnusson
On 8/17/07, Stanislav Malyshev <[EMAIL PROTECTED]> wrote: > > Neither. functions.xml is autogenerated by configure and referes to > > the filepath. > > So, the function list in main extension page gets one entry per file in > functions/? Where the names come from - is it refname? What if I have > m

Re: [PHP-DOC] phpdoc conventions on methods

2007-08-16 Thread Stanislav Malyshev
Neither. functions.xml is autogenerated by configure and referes to the filepath. So, the function list in main extension page gets one entry per file in functions/? Where the names come from - is it refname? What if I have more than one refname - is it only first? 2. There's two ways of ma

Re: [PHP-DOC] phpdoc conventions on methods

2007-08-16 Thread Hannes Magnusson
On 8/16/07, Stanislav Malyshev <[EMAIL PROTECTED]> wrote: > Another couple of questions: > 1. What does &reference.module.functions; (functions.xml) collect - > xml:id or refname? Neither. functions.xml is autogenerated by configure and referes to the filepath. > 2. There's two ways of making ex

Re: [PHP-DOC] phpdoc conventions on methods

2007-08-16 Thread Stanislav Malyshev
Another couple of questions: 1. What does &reference.module.functions; (functions.xml) collect - xml:id or refname? 2. There's two ways of making external links and xlink:href>. Is there a difference? Which one should be used? -- Stanislav Malyshev, Zend Software Architect [EMAIL PROTECTED] h

Re: [PHP-DOC] phpdoc conventions on methods

2007-08-16 Thread Hannes Magnusson
On 8/16/07, Stanislav Malyshev <[EMAIL PROTECTED]> wrote: > >> What if OO and procedural have different names, like Format->getError > >> and format_get_error? > > > > Life sucks :) > > Depending on the xml:id you can only create a link the OO way or the > > procedural way. > > I see. So then I can

Re: [PHP-DOC] phpdoc conventions on methods

2007-08-16 Thread Stanislav Malyshev
What if OO and procedural have different names, like Format->getError and format_get_error? Life sucks :) Depending on the xml:id you can only create a link the OO way or the procedural way. I see. So then I can't use for the second way - I should use then or ? Thanks for your help, -- St

Re: [PHP-DOC] phpdoc conventions on methods

2007-08-16 Thread Hannes Magnusson
On 8/16/07, Stanislav Malyshev <[EMAIL PROTECTED]> wrote: > > If you wrap it inside a element then drop the (), > > otherwise I'd say keep them > > When does function tag create link and when it doesn't? I saw sometimes I recently posted a note on the subject, see http://news.php.net/php.doc/9693

Re: [PHP-DOC] phpdoc conventions on methods

2007-08-16 Thread Stanislav Malyshev
If you wrap it inside a element then drop the (), otherwise I'd say keep them When does function tag create link and when it doesn't? I saw sometimes it does, but I'm pretty sure I saw cases when it doesn't. Generally, if I want to link to a function, should I use , or ? I see most docs use

Re: [PHP-DOC] phpdoc conventions on methods

2007-08-16 Thread Hannes Magnusson
On 8/16/07, Stanislav Malyshev <[EMAIL PROTECTED]> wrote: > What are the standards/conventions on the following matters: > > 1. Method names in reference.xml (when descripting class) - should I use >class->method or class->method() (with or without braces)? I see both > - compare PDO and DOM do

[PHP-DOC] phpdoc conventions on methods

2007-08-15 Thread Stanislav Malyshev
What are the standards/conventions on the following matters: 1. Method names in reference.xml (when descripting class) - should I use class->method or class->method() (with or without braces)? I see both - compare PDO and DOM docs. 2. Function names in function description (refname) - with or