Docblox: automatic documentation generator

1 year ago

(Just in case somebody has not noticed)... @Alexander has added docblox support to our source tree.
First commit was: Enabled automated doc building.

The idea is everybody willing the parsed/generated documentation should run docblox on its own clone of the repo.
(Not commiting the generated documentation into the master repo).

I've run it on my ubuntu desktop (not on my server [dreamhost]account).

Basically what i did was (in a step-by-step):

sudo apt-get install graphviz
sudo apt-get install php5-xsl
sudo apt-get install php-pear
sudo pear channel-discover pear.phing.info
sudo pear install phing/phing
sudo pear channel-discover pear.docblox-project.org
sudo pear install docblox/DocBlox
sudo pear install docblox/DocBlox_Template_abstract

changed dir into my friendica local clone and runned docblox without command-line arguments.
The doc index.html was generated inside the friendica/data/output.

The docblox documentation: http://docs.docblox-project.org/

#docblox #documentation #dev

@alexander #docblox #documentation #dev

Alexander Kampmann likes this.

3 comments show more

Abinoam Jr

1 year ago

The code for that was:

/**
 * Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
 *
 * The author's most recent status will be returned inline.
 *
 * Reference: <http://developer.twitter.com/doc/get/users/show>
 * 
 * @api
 *
 * @param App Friendica App Class
 * @param string Type of feed ("atom"|"rss"|"xml"|"json")
 *
 * @return string User template
 *
 */
 function api_users_show(&$a, $type){
   $user_info = api_get_user($a);

Abinoam Jr

1 year ago

@Simon L'nu as I study the friendica code I'll try to adapt the comments or add new ones so that the docblox could generate something worth of it.

@simon l'nu