Field API documentation [#362764]

The Field API documentation under development is now available at http://api.jaspan.com. This is a temporary arrangement until #361683: Field API initial patch gets committed.

The documentation is not done, but there is enough there to give you a sense of how the API works and what else needs to be documented. So, please read it and post comments here about:

* anything about the Field API you do not understand
* what documentation is missing
* what functionality is missing (assume the code perfectly implements the docs)
* any other constructive comments

You are also more than welcome to write and post new documentation. You can just post new text in a comment here, or submit a patch against the latest Field API code even before it is committed.

Comments

Comment #1

bjaspan CreditAttribution: bjaspan commented 24 January 2009 at 19:48

If anyone can tell me how to make an @link directive work without inserting a line break after a small amount of following text, I'd appreciate. The Field API doc homepage is pretty ugly at the moment until I figure this out.

Also, what is the best way to format data structure definitions? See http://api.jaspan.com/api/group/field_structs/7-fic for my current unreadable approach.

Comment #2

bjaspan CreditAttribution: bjaspan commented 27 January 2009 at 03:44

Priority:

Normal

» Critical

I fixed the bullet-list indentation on the documentation so it is not so annoying to read. I'm marking this critical because a review of the API itself is pretty much the most important thing we can have right now.