The "api" tab on http://drush.ws points to http://api.drush.org, which basically says nothing but

A main page for this branch has not been indexed. A documentation comment with @mainpage {title} needs to exist, or has not been indexed yet. For Drupal core, this is availiable in the developer documentation in the contributions repository. "

However, a diligent person *can* find content out there, like http://api.drush.org/api/groups/master

Right now it's pretty unfriendly to the truth-seeker though.

Comments

rfay’s picture

rfay
he,him
Primary language English
Location Palisade, CO, USA
commented
Category: bug » feature

I guess all we need is to commit an index page.

moshe weitzman’s picture

moshe weitzman commented

Anyone up for writing such a page? Just paste some text here and i will write and commit the patch.

kotnik’s picture

kotnik commented

Plain and simple:

"Welcome to the Drush developer's documentation."

Documentation certainly needs beautification (example).

jonhattan’s picture

jonhattan
Primary language Spanish
Location Plasencia
commented

It's not that easy. There're several deficiencies, some of them because of api.module is not able to parse drush code structure completely, some of them because some changes needed in drush to better leverate doxygen. Those are some of the annoyances I've hit over the time:

a) api.module doesn't know our engines system:
- several implementations of a engine: backup/svn/bzr for version control
- drupal version implementation of a engine: update_6.inc update.inc for d7 and above

* http://api.drush.org/api/function/package_handler_download_project/master
* http://api.drush.org/api/function/pm_update_filter/master

b) Tabs get crazy in some pages:
* http://api.drush.org/api/file/commands/pm/version_control/svn.inc/master

c) It doesn't index classes ¿? Perhaps I need to update to latest versions of modules.

d) api.module (or doxygen?) doesn't accept our docs/ as is. Perhaps it's enough to add some doxygen markup to our html files:
* http://api.drush.org/api/file/docs/bootstrap.html/master

e) although there have been efforts to documment drush we're not too strict in forcing ourselves to document functions, files, defining topics, etc. As an example there're too few topics (@defgroup in doxygen):

* http://api.drush.org/api/groups/master

kotnik’s picture

kotnik commented

b) Tabs get crazy in some pages:
* http://api.drush.org/api/file/commands/pm/version_control/svn.inc/master

Also, breadcumbs are missing on some pages, ie. here.

c) It doesn't index classes ¿? Perhaps I need to update to latest versions of modules.

Definitely.

Also, all of us could put some extra effort to fix existing, and improve future documentation. We just need to agree on when to do this.

moshe weitzman’s picture

moshe weitzman commented

Patches are welcome now. Some of this is easy to fix, and all of it is vauable imo ... Recent versions of api module do handle classes.

greg.1.anderson’s picture

greg.1.anderson commented
Version: » 8.x-6.x-dev
Status: Active » Closed (won't fix)
Issue tags: +Needs migration

This issue was marked closed (won't fix) because Drush has moved to Github.

If this feature is still desired, you may copy it to our Github project. For best results, create a Pull Request that has been updated for the master branch. Post a link here to the PR, and please also change the status of this issue to closed (duplicate).

Please ask support questions on Drupal Answers.