While the various hooks are documented on api.aegirproject.org, no "topic" is generated.

Example, this hook is detected by the api module:

http://api.aegirproject.org/api/Hostmaster/modules--hosting--hosting.api...

... but the group it is supposed to be in ("@addtogroup hooks") isn't:

http://api.aegirproject.org/api/Hostmaster/modules--hosting--hosting.api...

This makes the module harder to browse...

Comments

Steven Jones’s picture

Yeah this is because we don't actually define that group anywhere at the moment, but core does define the group, so what I think we need to do is add a file that adds the group, but not add it to hostmaster/provision.

I.e. whomever is responsible for the api site needs to manually add the file to the directory of files that are scanned.

ergonlogic’s picture

Assigned: Unassigned » ergonlogic

... whomever is responsible for the api site...

Okay, that would be me.

... add a file that adds the group, but not add it to hostmaster/provision.

Does anyone have an example of what this file is supposed to look like? Is it just some @defgroups as per http://drupal.org/node/1354#groups?

I haven't found any @defgroups yet, but I'm guessing it should look something like this: http://drupalcode.org/project/documentation.git/tree/refs/heads/6.x-1.x:....

Why not add it to hostmaster/provision? If indeed not, then should I start an aegir_documentation project to host it? It seems to me that it still needs to be available via Git somewhere.

Steven Jones’s picture

I'm not sure what happens if you try to define two groups of the same name, which would happen if someone popped aegir and core into the same API site.

anarcat’s picture

Assigned: ergonlogic » anarcat

I think we should create a new group for the frontend hooks. maybe called "hosting_hooks"?

I could write a blurb...

anarcat’s picture

Some other notes:

doxygen reference: http://drupal.org/node/1354

we would profit a lot from an index.php file: http://drupalcode.org/project/documentation.git/blob_plain/refs/heads/6....

anarcat’s picture

Status: Active » Fixed

Okay, I just went crazy in there and documented a bunch of groups, things should be more readable now. I have also added a simple index page while I was there. Let's see how that looks after it gets regenerated on the API site! :)

anarcat’s picture

btw, not being sure if the docs are generated from the 1.x or 2.x branch (that should be clarified, or we should have another site for 2.x?), I merged most of the docs back into the 1.x branch, hopefully not breaking anything...

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.