Posted by jhodgdon on April 18, 2010 at 10:17pm
4 followers
| Project: | API |
| Version: | 6.x-1.x-dev |
| Component: | User interface |
| Category: | feature request |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | closed (fixed) |
Issue Summary
We have a doc standard for lists in doxygen:
- key: information about key
It would be nice if the API module, when faced with - key: would use bold or italics or something like that to highlight the keys in the list. Or make a DT list instead of a UL list. Or something like that.
Comments
#1
Here's a patch that does this.
Examples of pages with lists:
- hook_menu() [return value]
- I also added a list to the sample.php file, in sample_function().
Attached is the patch and a screen shot of what it looks like. Reviews welcome!
#2
As a note, all the tests still pass with this patch (I guess we weren't testing the exact list formatting, which I guess I knew since there weren't any lists in the sample docs).
#3
Oh yes please. But are the quotations still necessary with the improved styling?
#4
The quotes are in the hook_menu docs source code. I don't want to see the API module removing quotes that have been put there, and it isn't adding them.
Granted, hook_menu is not following our list formatting guidelines by putting them there, but that's a separate issue.
#5
Looks okay. Some tests would be great.
#6
Added tests (including a test for list formatting with some nested lists, and a test for this new formatting) and committed.
http://drupalcode.org/project/api.git/commit/067726c
#7
Automatically closed -- issue fixed for 2 weeks with no activity.
#8
Follow-up:
#1427598: List formatting is a bit too aggressive