Antoine Mercadal
4acda0c447
fix and update css for documentation when using doxygen 1.8
2012-09-14 14:33:13 -07:00
Antoine Mercadal
d1c978669b
run ImageOptim on all images. Saved around 30% of original size
2012-08-24 11:48:55 -07:00
Aparajita Fishman
3eb4155489
Switched to /usr/bin/env bash for better cross-platform compatibility
2012-04-26 19:11:05 +02:00
Aparajita Fishman
9e8f659faf
Stop generating useless XML from doxygen.
2012-03-26 12:47:05 -07:00
Aparajita Fishman
b99ece088d
Prevent doxygen from parsing @implementation within comments
2012-03-21 12:48:12 -07:00
Aparajita Fishman
1c2a304ee5
Assignment of function is a statement and should be semicolon terminated. Some miscellaneous linting as well.
2012-01-05 17:51:37 -10:00
Antoine Mercadal
1a51acf2fc
fix doc style under Windows. Thanks to @jakemarsh (fork removed). close #1401
2012-01-03 17:21:02 +01:00
Antoine Mercadal
4ec7cea6c4
update doxygen displayed Cappuccini version to 0.9.5
2011-11-16 15:12:22 +01:00
Antoine Mercadal
8dab47f4da
mozilla compat
2011-09-08 18:12:32 +02:00
Antoine Mercadal
dcbe3ee650
fix paremeters touching their description in bubbles
2011-09-08 17:15:12 +02:00
Antoine Mercadal
e32489aba1
tiny padding improvment in generated html docs
2011-09-08 17:08:50 +02:00
Antoine Mercadal
b619c0b793
some small graphical improvments
2011-09-08 16:55:12 +02:00
Antoine Mercadal
fab61d14fa
forget to restore the bg color of the tree view
2011-09-08 14:44:05 +02:00
Antoine Mercadal
b4edc084f8
add Cappuccino logo
2011-09-08 14:00:20 +02:00
Antoine Mercadal
c7518d0c49
merge Aparajita's previous improvments on the CSS
2011-09-08 12:44:10 +02:00
Antoine Mercadal
a40345c14d
fix the slider
2011-09-08 11:46:20 +02:00
Antoine Mercadal
909471a5d7
fix the documentation generation process
2011-09-08 01:30:58 +02:00
Antoine Mercadal
38f7ea00c2
update doxygen.css
2011-09-08 00:43:32 +02:00
Aparajita Fishman
4f7fbdc344
Use Menlo if Consolas is not available
2011-06-01 18:22:57 -07:00
Alexander Ljungberg
1c201d7dba
Refs #1270 . Fix a typo.
2011-05-19 21:50:30 -04:00
Aparajita Fishman
aa7345935d
Oops, accessor methods weren't being synthesized, removed some cruft
2011-05-19 17:10:50 -07:00
Aparajita Fishman
3937e66e06
Major fix to documentation generation:
...
- It turns out doxygen would not generate documentation for the first method in a file (or sometimes any methods at all) if there was no ivar block or an empty ivar block. Now a dummy __doxygen__ ivar is inserted in empty blocks to force correct behavior.
- Added a missing @endverbatim to CPExpression.j.
- Tweaked class documentation for CPPredicate.j.
2011-05-19 16:47:11 -07:00
Aparajita Fishman
896f91215e
Whitespace cleanup
2011-05-18 16:54:21 -07:00
Aparajita Fishman
6d962bc51a
More documentation enhancements...
...
- Changed to centered, fixed-width layout, it results in shorter line lengths which reads more easily.
- Moved support files to separate support directory.
- Removed blank lines at end of multi-parameter method prototypes.
2011-05-18 07:50:27 -07:00
Aparajita Fishman
800e32edad
Missed a text substitution, darkened up the method header a bit
2011-05-17 21:14:01 -07:00
Alexander Ljungberg
3fe907f007
Merge remote branch 'aparajita/better-docs' into 0.9.1
2011-05-14 13:28:19 -04:00
Alexander Ljungberg
d4d01d9686
Refs #1261 . Clean up README.html tmp build file when jake docs is done.
2011-05-14 13:10:49 -04:00
Alexander Ljungberg
7ca8d0fb01
Whitespace cleanup.
2011-05-14 13:05:07 -04:00
Aparajita Fishman
b985081184
Tweak the class list page
2011-05-12 23:16:50 -04:00
Aparajita Fishman
02f61fa413
Lightened up box around method prototype
2011-05-12 16:56:28 -04:00
Aparajita Fishman
be5bbdcb32
Another overhaul of doc generation.
...
- Added generic facility for pre- and post-processor scripts to be run.
- Added support utility script for inclusion by processors.
- Totally overhauled css to make the pages more readable (I hope).
- Fixed some doc errors in CPTableView.
- Don't generate XML.
- Added colorize() and colorPrint() functions to common.jake.
- Added docs-no-frame task for generating docs without a sidebar frame.
2011-05-12 14:41:54 -04:00
Alexander Ljungberg
501c15775e
Use bsdtar explicitly for 'jake docs' in case the user has GNU tar installed through e.g. fink.
...
This enables the -s parameter to work.
2011-04-03 16:58:39 -04:00
Alexander Ljungberg
370960418f
Better formatting, clickable links and basic code styling for the Doxygen docs front page. This look will resemble that of the GitHub front page.
...
The README file was converted to Markdown which is nice to read in the terminal and automatically formatted by GitHub. For Doxygen, the markdown is first converted to HTML.
2011-04-03 14:34:20 -04:00
Randall Luecke
cf6d7f2d85
Rev version number to 0.9.1
2011-03-25 23:36:07 -04:00
Aparajita Fishman
dc801a11c8
Instead of blindly, recursively copying the AppKit and Foundation directories, more intelligently copy only the *.j files we want.
2011-03-12 23:34:53 -05:00
Randall Luecke
191a02a89b
Update documentation version number to 0.9.
2011-01-24 14:28:07 -05:00
Aparajita Fishman and Alexander Ljungberg
f46f97f8b6
Implemented doxygen parsing of @accessors synthesized methods, moved @accessors declarations in .h files to a comment to prevent improper parsing.
2010-09-17 21:19:02 -04:00
Aparajita Fishman and Alexander Ljungberg
8dd1d20a2d
Made sure to remove the .doc directories first, fixed exec
2010-08-27 19:29:11 -04:00
Aparajita Fishman and Alexander Ljungberg
ad5badb0d7
Remove @import statements from source files, doxygen doesn't parse them correctly.
2010-08-27 19:28:23 -04:00
Aparajita Fishman and Tom Robinson
90a63e1b14
Fixes/enhancements to jake docs:
...
- We now have class hierarchy information! Don't remove generated headers before doxygen runs so it can generate class hierarchies. Now the headers are cleaned up separately.
- Added inline collapsible class hierarchy diagrams within each class.
- Enabled the built-in search! It's awesome!
- Changed image format to gif, dot is generated invalid png on Mac OS X.
- Explicitly turned off generation of to do and bug list.
- Turned off most warnings, most of them are useless warnings arising from the fact that we are pretending Objective-J is Objective-C.
- Doxyfile format updated to 1.7.1.
2010-08-13 15:42:43 -07:00
Ross Boucher
d600df4585
Make doxygen recursive.
2010-03-01 12:14:27 -08:00
Ross Boucher
dbe0ca0adc
Expand macros in the documentation generation.
2010-02-27 10:31:05 -08:00
Ross Boucher
2b66683167
Update the documentation config based on feedback from:
...
http://cappnotes.worldofkrauss.com/sectins/objective-j-categories/8-miscellaneous/14-api-documentation-fixes.html
If you have graphviz installed, graphs will now be generated.
Ruby and doxygen are prereqs for building the docs.
2010-02-02 18:35:42 -08:00
Ross Boucher
7f60bdec4f
Update the documentation of methods define with the BRIDGE macro
2009-06-01 10:01:44 -07:00
Ross Boucher
5507855bee
update to default template, doxygen config file
2009-05-18 18:54:30 -07:00
Ross Boucher
850125b8ab
Add documentation groups
2009-05-18 15:43:36 -07:00
Ross Boucher
52d3115ad6
update the doc config to exclude themes
2009-05-18 10:41:11 -07:00
stephen and Ross Boucher
89e776281f
Added @mainpage for doxygen that simply includes the README and LiCENSE
...
docs. Also added groups for appkit and foundation classes.
2009-03-05 14:20:39 -08:00
Francisco Ryan Tolmasky I
d92fc8c4d0
Cleaned up old deprecated documentation stuff and added documentation to deploy.
...
Reviewed by me.
2008-12-10 15:57:31 -08:00
Thomas Robinson
a7a4740c60
Ant task for creating docs ("ant docs") and removed absolute paths from Doxyfile.
2008-12-02 02:10:44 -08:00