Opened 7 years ago

Closed 6 years ago

#10512 closed enhancement (fixed)

[PATCH] Tweaks to the API documentation

Reported by: waddlesplash Owned by: nielx
Priority: normal Milestone: R1
Component: Documentation Version: R1/Development
Keywords: Cc:
Blocked By: Blocking:
Platform: All


The commit message aptly describes what this patch does:

  * Update the Doxyfile for Doxywizard reformatted the comments; that's why this change is so big
  * Disable graph inheritance trees; use "Inherits/Inherited by" lists instead (Doxygen has this on by default; I don't think it was intentional)
  * Shorten two subgroup names; helps with formatting in Doxygen 1.8 and looks cleaner
  * Moves the page footer ("The Haiku Book pre-R1...") be in a <footer> tag, and add a CSS rule for this tag
  * Disable XML output, no one is using it
  * Disable Microsoft IDL parsing, speeds up Doxygen a bit

Attachments (1)

0001-Tweaks-to-the-API-documentation.patch (132.9 KB ) - added by waddlesplash 7 years ago.
The patch file

Download all attachments as: .zip

Change History (9)

by waddlesplash, 7 years ago

The patch file

comment:1 by waddlesplash, 7 years ago

patch: 01

comment:2 by jscipione, 7 years ago

Like I said on the haiku-doc mailing list, I prefer the inheritance graphs as they are now. The rest of the changes seem fine. It's a little annoying that trailing spaces were added to the Doxyfile by the updated but oh well. We still don't have a way to make code blocks indent correctly in Doxygen 1.8 unfortunately.

in reply to:  2 comment:3 by waddlesplash, 7 years ago

Replying to jscipione:

We still don't have a way to make code blocks indent correctly in Doxygen 1.8 unfortunately.

Probably because 1. markdown support is on by default in 1.8; this can be fixed in the Doxyfile and 2. the CSS tags got a makeover, our "book.css" file will have to be updated.

comment:4 by pulkomandy, 7 years ago

+1 on removing the graphs from me. They are going to grow as we add classes to the book, making them less useable than they are now (look at BArchivable to see how annoying this can get).

Instead, we could have a single graph with all classes, or maybe one per kit or something. At least make them hidden by default so you can more easily get to the useful part of the page.

comment:5 by jscipione, 7 years ago

"The options DOT_GRAPH_MAX_NODES and MAX_DOT_GRAPH_DEPTH can be used to limit the size of the various graphs."

comment:6 by jscipione, 7 years ago

I've committed this patch will all changes except for setting CLASS_DIAGRAMS = NO in hrev46948.

comment:7 by waddlesplash, 6 years ago

I think this ticket can be closed now. The issue of graphs can be resolved elsewhere.

comment:8 by pulkomandy, 6 years ago

Resolution: fixed
Status: newclosed
Note: See TracTickets for help on using tickets.