Re: [PHP-DOC] "Source URLs" as source control properties

2011-12-11 Thread Nikita Popov
On Sun, Dec 11, 2011 at 11:43 AM, Hannes Magnusson
 wrote:
> I'm unsure how useful this really is.
> The structure of php-src is very straight forward and easy to
> figureout which file the function is in..
> The problem may maybe rise when talking about pecl extensions, but
> then again - not all of them are in php svn tree.. so if I can't get
> it on all files.. whats the point?
It is also pretty straightforward to find function definitions using
lxr.php.net. Just type the function name into the search and you'll
find the definition. If it is a very commonly used function and the
definition is buried in the results just search for "PHP_FUNCTION
func_name" which will get you to the right results.

Nikita


Re: [PHP-DOC] "Source URLs" as source control properties

2011-12-11 Thread Hannes Magnusson
On Fri, Dec 9, 2011 at 08:01, Justin Martin  wrote:
> Hello everyone,
>
> I've been playing around in a branch of doc-base and en to see if there's an
> elegant way to implement linking to the related php-src *.c file of
> functions and methods (and possibly more, in the future).
>
> The idea is that when documenting a function or method, it's often necessary
> to pull up the source for it. To do so, one typically has to grep the
> sources or guess where the function or method is defined. My hope was to set
> a source control property on each function and method file, which points to
> the URL of the of the source file.

I'm unsure how useful this really is.
The structure of php-src is very straight forward and easy to
figureout which file the function is in..
The problem may maybe rise when talking about pecl extensions, but
then again - not all of them are in php svn tree.. so if I can't get
it on all files.. whats the point?

-Hannes


[PHP-DOC] "Source URLs" as source control properties

2011-12-08 Thread Justin Martin

Hello everyone,

I've been playing around in a branch of doc-base and en to see if 
there's an elegant way to implement linking to the related php-src *.c 
file of functions and methods (and possibly more, in the future).


The idea is that when documenting a function or method, it's often 
necessary to pull up the source for it. To do so, one typically has to 
grep the sources or guess where the function or method is defined. My 
hope was to set a source control property on each function and method 
file, which points to the URL of the of the source file.


By doing this, it becomes trivial to use a command to pull up the 
sources. An example would be "google-chrome `svn propget srcurl %f`"


As well, beyond this, it would become possible to add links in the 
reference pages themselves based on that property. To that end, there 
was a concern that the increase in traffic towards viewvc might cause 
problems, but that's just an idea.


My branches can be found at 
phpdoc/doc-base/branches/function_definitions/ and 
phpdoc/en/branches/function_definitions/


Any ideas or concerns?

Thanks,
Justin Martin