Commit Graph

21 Commits

Author SHA1 Message Date
John Scipione
7177815b20 Use regular bullets for lists, matches User Guide 2015-01-27 19:14:36 -05:00
John Scipione
ba88ee2be4 Allow ol's to show numbers 2014-07-02 11:11:57 -04:00
John Scipione
955ace81fd Move the search text box to the right
The "API DOCUMENTATION" text placement corresponds similar text in the
User Guide.
2014-06-30 15:22:53 -04:00
Augustin Cavalier
67e4499bbe Add search function to the API docs.
* Uses Google site search.
 * CSS taken from the User Guide Translator's CSS.

Signed-off-by: John Scipione <jscipione@gmail.com>
2014-06-30 15:22:52 -04:00
John Scipione
1c52b28f3e Add styling for \since command 2014-06-11 16:25:32 -04:00
waddlesplash
dba29137b2 Tweaks to the API documentation
* Update the Doxyfile for 1.7.6.1. 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
2014-02-27 17:21:51 -05:00
John Scipione
30b280b217 Style the interface diagram title as an h2 2013-02-07 14:49:43 -05:00
John Scipione
027cfe666e Bound the interface diagram.
The interface diagram for BArchivable has become too wide to fit on
the page so I've put the diagram in a box and made it scrollable.
While I'm at it give the interface diagram a silver border and
center it on the page.
2013-02-07 14:42:20 -05:00
John Scipione
820dca4df6 Big docs cleanup.
* Fixed headers including:
  - All rights reserved not All Rights Reserved.
  - name, email@domain.com not name <email@domain.com>
  - tabs and spaces
  - Authors: not Documented by:
* Renamed string.dox to String.dox
* Renamed midixxx.dox files to MidiXxx.dox
* Moved images into images subdirectories and updated Doxfile.
* Re-format all files with tabs instead of spaces.
* Fix many spelling mistakes.
* Added all files, classes, structs, and enums to libbe group.
2013-02-07 02:01:19 -05:00
John Scipione
a3c5efd2e9 Color parameters in parameter lists grenadier (orange) as well. 2013-01-30 18:58:55 -05:00
John Scipione
c896b0c34c Color parameters grenadier (orange) in API docs. 2013-01-30 18:54:16 -05:00
John Scipione
8bbff5c9ed Update dd style in API docs.
Only make the font size 12px for the special note, warning, etc. blocks
not all dd blocks.
2013-01-30 18:43:09 -05:00
John Scipione
c45e8003d3 Update font size of memberdoc tables from 13px to 14.4px 2013-01-17 18:13:05 -05:00
John Scipione
4aae53f373 Update Haiku Book CSS
* Update headers to match User Guide better for font and spacing.
* 14.4px is the default font size (matching user guide).
* because we use em's for page width this makes the text area a bit narrower.
* Make note, warning, stop, remark notifications font size smaller to make
  them stand out a bit less and better matches the User Guide.
2013-01-16 12:44:22 -05:00
John Scipione
e1988c7d53 Reduce font size of code blocks to 13px 2012-12-23 12:05:03 -05:00
John Scipione
4466b89c65 Add a section to the Haiku Book with a very special topic, the keyboard.
This started off as just being a page to detail the key codes since I find
myself constantly referencing the BeBook page on the subject and it is
horribly broken. However, the page has grown to detail many of the keyboard
related methods and constants defined in InterfaceDefs.h as well. A very
long and detailed explanation of the key_map structure is included.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43230 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-10 08:35:38 +00:00
John Scipione
6ac7032dc6 Update the style of the Haiku Book to resemble the User Guide.
If you have never seen this before you are in for a bit of a shock.
Update the Doxyfile to 1.7.3 (the version that gets auto-generated).

Update the book.dox front page with some nice introductory text.

Add new documentation for the following classes:
BCheckBox
BClipboard
BColorControl
BControl
BEntryList
BView (preliminary)

Remove redundant documentation from src/kits/storage/EntryList.cpp

Minor documentation update for the following classes:
BAlert
BApplication
BArchivable
BBox
BButton
BCatalog
BFindDirectory
BHandler
BUnarchiver
BString

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43096 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-02 08:36:02 +00:00
Adrien Destugues
a33f8fbdec Merge work by John Scipione on the Haiku Book.
* Some new classes documented
 * Screenshots for the interface kit controls
 * A lot of typo fixes
 * Some css tweaks

This has some backporting to the current version of Doxygen, since 
there are experiments to get coloring similar to the one in the Be 
Book that will hopefully be upstreamed in Doxygen.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42608 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-08-09 21:46:13 +00:00
Adrien Destugues
3290008f1e * Add the warning and info boxes from userguide. However, I don't know how to upload the associated images to the api
server.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37981 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-09 08:46:16 +00:00
Niels Sascha Reedijk
702a1e7241 Tweak looks of API documentation.
WIP:
 * Only a first subset of CSS has been applied
 * Look based on Humdinger's and other's work on user guide
 * Navigation is still ugly. I need to work around the limitations of Doxygen. Maybe by a patch though.
 * Needs a manual extra step: you need to copy the /trunk/docs/userguide/images/logo.png to the /trunk/generated/doxygen/html directory

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29117 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-02-01 21:44:07 +00:00
Axel Dörfler
d99a9fa0a5 Hacked together a BeBook style derivation of the standard doxygen.css
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@4388 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-08-27 03:44:59 +00:00