Posted by danielb on July 23, 2009 at 4:34am
Jump to:
| Project: | API |
| Version: | 6.x-1.1 |
| Component: | Code |
| Category: | feature request |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | active |
Issue Summary
I really don't want to have to put the Drupal Core files into my repo (because then I will have to maintain it) but I would still like the links for Drupal functions to work.
Would it be possible to create a feature similar to how you can link functions to the PHP manual, except so I can link to other manuals/APIs such as api.drupal.org, drupalcontrib.org, freestylesystems.co.uk, etc...
Comments
#1
To clarify I am just making an API reference for one particular contrib module http://braksator.com/api
#2
Multiple branches indexing URLs like http://cvs.php.net/viewvc.cgi/phpdoc/funcsummary.txt?view=co is now supported. API doesn't publish that format, and we need something that covers more than functions.
#3
I think the feature request here is so that in this person's API module installation, Drupal core functions would automatically turn into links to the appropriate page on api.drupal.org. Etc. The same way that currently in the API module, you can make PHP functions turn into links to php.net.
#4
Note that this duplicate issue has some more information:
#1190666: Generate a funcsummary.txt
#5
Changing the title... So it sounds like the tasks here would be:
a) Set up the API module so it can use a more general funcsummary.txt-like file, which would include not only functions, but also classes, topics, constants, etc.
b) Set up the API module so it would generate this more general file.
And by the way the current URL for the php.net summary file is:
http://svn.php.net/repository/phpdoc/doc-base/trunk/funcsummary.txt
I don't see anything there that has classes, globals, constants, or interfaces in it (but that file does include methods).
#6
Also note that we do have a URL api/function_dump/[branch], which publishes a list like this (for the sample code):
sample_function($parameter, $complex_parameter) ### A sample function.duplicate_function() ### For testing duplicate function name linking.
duplicate_function() ###
public foo() ### Metasyntatic member function.
public baz() ### Only implemented in children.
public foo() ### Implement this API.
public bar() ### A public method.
Problems:
- Not the same format as the php.net list.
- Only includes functions and methods. We need to list other stuff too.
- Probably should have the class name on methods [Sample::foo()]
There's also some suggested code on
#1190666: Generate a funcsummary.txt
that's kind of similar.
It would be a start though I guess.