From Natalya’s Email

I’m back online now and would like to begin with documenting the Error functions in the API (sp_construct_database_error, sp_construct_php_error, sp_write_error, sp_gis_error).

I’m assuming the format in the codex will be similar to WP’s codex structure.

As an example I went out to WP’s apply_filters codex page (http://codex.wordpress.org/Function_Reference/apply_filters) and they have the following headings. I’m assuming you would want at least the first 5 items on an SP codex page for a function:
• Description
• Usage
• Parameters
• Return
• Examples
• Notes
• Change Log
• Source Files
• Related

I was also wondering if the team has used any documentation generators for populating the codex.

I would say the the first 5 on the list plus the Source Files or where the function is located.
Notes only if needed.  Related would be hard to do.
Steve or Andy might have a different idea.

Change log is also a bit of an issue. What I usually do is put in the current SP version at the time of writing the entry. It would be way to much work to actually go back and put previous changes/versions in.  There is also no one that is going through and updating any functions changes with new versions but having the version number put in at the time of writing gives everyone an easy way to see when the entry was last updated.

There also may be an issue where all the current functions on http://codex.simple-press.com/codex/api/template-functions-and-the-api/api-helper-functions/ are not included.  It looks like that page is about 2 years old. Before starting we should update that page and then it will be easier to start at the top and work down. I could probably do a function search and go through the list fairly easily.

I haven’t used a document generators for the Codex myself, Maybe Andy or Steve may has used one before.