summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2014-01-30autoconf: use default xorg configuration for doxygen documentationGaetan Nadon
No content or form changes for the xcb manual or tutorial. Only the configuration user visible bits change. Xcb will now have the same configuration options as the 30 other xorg modules. Xorg classifies documentation as "user", "developer" or "specifications". The xcb manual falls under the "developer" category. Developers docs are never installed under $prefix. A builder can selectively turn on/off any or all of the categories. He can also selectively turn on/off any of the many tools used to generate documentation such as doxygen, xmlto, etc... Each tool has an environment variable defined such as DOXYGEN. Other features are available, the user interface and the functionality is the same on all modules. --with-doxygen=FILE is replaced with DOXYGEN env variable --disable-build-docs is replaced with --disable-devel-docs The new interface displayed with ./configure --help: --enable-devel-docs Enable building the developer documentation (default: yes) --with-doxygen Use doxygen to regenerate documentation (default: auto) DOXYGEN Path to doxygen command DOT Path to the dot graphics utility The dot tool checking has been added to util-macros in version 1.18. Refer to the table of existing docs in xorg. XCB will be added for the doxygen generated API manual. Reviewed-by: Josh Triplett <josh@joshtriplett.org> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2012-02-10Add xkb_internals and xkb_issues to EXTRA_DIST.Arnaud Fontaine
2010-09-08Merge branch 'gsoc2010' of git://anongit.freedesktop.org/~chr/libxcbPeter Harris
2010-08-16small fix to get rid of some compiler warningsChristoph Reimann
also added very basic documentation for xkb
2010-08-05Tutorial uses wrong function.Eamon Walsh
https://bugs.freedesktop.org/show_bug.cgi?id=29392 Signed-off-by: Eamon Walsh <efw@eamonwalsh.com>
2009-12-08Tutorial code fixJim Ingram
Accessed elements of names[] after freeing them in the first example. Signed-off-by: Julien Danjou <julien@danjou.info>
2009-10-15Fix typo in the tutorial.Eric Anholt
2007-04-12remove the 7th bit of the response_type for the event loopsTORRI Vincent
2007-02-07and make the html code valid...TORRI Vincent
2007-02-07font partTORRI Vincent
2007-02-07no more xid or id fieldsTORRI Vincent
2007-02-06add the complete cursor example. Make the html code validTORRI Vincent
2007-01-13fix all the occurence where a drawable where considered as a unionTORRI Vincent
2006-11-24replace all the _new functions with xcb_generate_id. repalce X11/XCB with ↵TORRI Vincent
xcb. Fix a description of the default background of a window
2006-11-23Rewrite automake's data installation rules, because they suck.Josh Triplett
Specifically, they didn't handle installing data from both srcdir and builddir. We have the tutorial in the srcdir, and build the manual in the builddir. Also, stop rebuilding the manual for each make target in the doc directory, and every time any of those targets get called. This change now makes the manual never rebuild once built; we plan to fix that later, by rewriting the makefiles to avoid recursive make, and then making the manual depend on the source files. Commit by Jamey Sharp and Josh Triplett.
2006-11-23Rework doxygen build and install to work with srcdir != builddirJosh Triplett
The documentation generation with doxygen now works when built out of tree, with srcdir != builddir. xcb.doxygen now gets generated from xcb.doxygen.in, so that it can use top_builddir and top_srcdir to find source and to output documentation. Also fill in PROJECT_NUMBER from @VERSION@, now that we have it readily available via autoconf.
2006-11-18Make doc installation work and simplify doc/Makefile.am.Jamey Sharp
Don't override the default htmldir with an unquoted copy. Don't suppress `make` echoing on Doxygen commands. Ensure the tutorial is always installed even if Doxygen isn't available. Take better advantage of the automake installation infrastructure.
2006-11-05add Makefile.am for building/installing doxygen docTORRI Vincent
2006-10-19Add doxygen config file.Jamey Sharp
Thanks to Jeremy Kolb <jkolb@brandeis.edu> for the initial version.
2006-09-30fix some indentation, remove args of the main function (not needed), ↵TORRI Vincent
xcb_sync -> xcb_aux_sync. Jamey, it seems that your script transforms XCBGetSetup into a type, instead of a function. Same for XCBSetupVendor. Maybe there are other fuctions that have the same problem.
2006-09-30update tutorial to the new api. Add some doc about cursors. Add some colors ↵TORRI Vincent
to section 6 (Opening and closing the connection to an X server). Tell me if you want to keep colors or not (colors can be modified in xcb.css)
2006-08-14Tutorial corrections.Thomas Hunger
2006-07-25fix closing <b> tagTORRI Vincent
2006-04-27Fix tutorial to use XCBSetup rather than the previous deprecated name ↵Josh Triplett
XCBConnSetupSuccessRep.
2006-04-27Remove execute bit on tutorial.Josh Triplett
2006-03-22Work on the tutorial, and update xproto.xml to match:Ian Osgood
* Fixed grammar * Answered some TODO's and added some more * Updated X.h constants to those in xproto.h * Added enumerations used in tutorial to xproto.xml * Prefered XCBFlush to XCBSync * Corrected and refactored the "events" example I extracted the examples to test them. Where should I put them?
2006-03-05wrong spacesTORRI Vincent
2006-03-05fix some font sizesTORRI Vincent
2006-03-05fixes + valid cssTORRI Vincent
2006-03-05fixes + valid cssTORRI Vincent
2006-03-05lots of fixes. Thanks to Indan ZupancicTORRI Vincent
2006-03-05lots of fixes. Thanks to Indan ZupancicTORRI Vincent
2006-02-18Remove xcl and CVSROOT.Josh Triplett