summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* doc/publican/Makefile.am: Add a missing order-only prerequisiteRui Matos2015-01-281-1/+1
| | | | | | | | Otherwise a parallel make invocation could fail due to the directory not existing. Signed-off-by: Rui Matos <tiagomatos@gmail.com> Reviewed-by: Jon A. Cruz <jonc@osg.samsung.com>
* doc: update diagrams for compatibility.Jon Cruz2015-01-282-47/+47
| | | | | | Change attribute separators for compatiblity with graphviz older than 2.30. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
* doc: Create hot-linked areas in documents.Jon Cruz2015-01-284-35/+134
| | | | | | | Added xslt processing to give DocBook output diagram image maps/hot-linked areas consistent with those automatically generated by Doxygen. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
* doc: Switch from static image files to generated diagrams.Jon Cruz2015-01-286-13/+124
| | | | | | | Switches diagrams from using static PNG images to instead generate them via simple graphviz DOT markup files. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
* doc: Put a dash between type/enum value and descriptionBill Spitzak2015-01-261-5/+5
| | | | | | This was suggested by Derek Foreman, I think it looks better Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: Add macros and typedefs to the documentationBill Spitzak2015-01-261-1/+2
| | | | | | | | | If somebody bothered to put a doxygen comment in for a macro or typedef, make it appear in the pages. This produces documentation for wl_container_of and wl_dispatcher_func_t from the _8h files. Reviewed-by: "Jon A. Cruz" <jonc@osg.samsung.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: there is no need to move the _8h filesBill Spitzak2015-01-261-8/+0
| | | | | | | | The current xslt skips all the data that is in them, so it is ok if they are included. Reviewed-by: "Jon A. Cruz" <jonc@osg.samsung.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: remove redundant subtitlesBill Spitzak2015-01-231-13/+25
| | | | | | | | | Put the argument lists next to the event/message title, which I think makes it a lot easier to understand, and remove redundant "values" title from enumerations. Reviewed-by: Derek Foreman <derekf@osg.samsung.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: Add object types and links to arguments int protocol documentationBill Spitzak2015-01-231-0/+35
| | | | | | | This makes it a lot easier to figure out what is going on! Reviewed-by: Derek Foreman <derekf@osg.samsung.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: compress the lists in the protocol docs someBill Spitzak2015-01-231-9/+21
| | | | | | | | Use simpara to remove the blank lines, and put the type/value and the comment into the same line. Reviewed-by: Derek Foreman <derekf@osg.samsung.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: make itemized lists from doxygen workBill Spitzak2014-12-191-0/+8
| | | | | | Not actually used currently but probably a good idea. Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: Document structures and unions in addition to classesBill Spitzak2014-12-191-10/+15
| | | | | | | | | This provides targets for some of the doxygen links, and some of them have useful memberof function lists. Added some if/else statements to reduce validation errors. Tested-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: Each class in doxygen output is a sectionBill Spitzak2014-12-191-15/+21
| | | | | | | | | | All the methods belonging to the class are listed with it, making it much easier to find them. I dumped all other functions into a section called "Functions" at the end. Tested-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: removed the word "interface" from the link namesBill Spitzak2014-12-194-21/+18
| | | | | | | | Just to make it slightly shorter. Also add a dash to the doxygen links to make them look a bit more alike. Tested-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: Reduce the validation errors of the docbook inputBill Spitzak2014-12-193-33/+23
| | | | | | | | | | | | | | | | | | | | | | (this is different from previous version as it removes some broken and irrelevant changes to the protocol appendix). This removes all the validation errors except for missing link targets. You can test this by removing the --skip-validation from doc/publican/Makefile.am. Main changes are to avoid nesting <para> commands. I also used <simpara> in some places to reduce the amount of blank space. And the reference id's are prefixed with the chapter name to avoid collisions between libclient and libserver. PS: it would be useful if somebody who actually knows something about xslt would come up with a way to translate a block of text makde of <para> commands unchanged, but add <para> around plain text. Most of the difficulty is that doxygen's output is rather inconsistent here. Tested-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* fixup doc: Make it easier to add a new doxygen pageBill Spitzak2014-12-181-1/+1
| | | | | | This supersedes the previous one and fixes a typo where a slash was missing. Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: Make it easier to add a new doxygen pageBill Spitzak2014-12-184-41/+25
| | | | | | | | | The repetitive parts of generating the server and client documentation are merged, so it is easier to add another doxygen chapter: add a new line to $publican_sources in publican/Makefile.am, and a list of C source files to doxygen/Makefile.am. Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: fix for parallel makeBill Spitzak2014-12-181-3/+4
| | | | | | | | Move the *_8h.xml files to a per-chapter temporary file so two chapters can be converted from doxygen at the same time. Tested with make -j 9. Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: Split libwayland-client and -server into different pagesBill Spitzak2014-12-164-35/+24
| | | | | | | | | | | This was suggested before to make it clearer that things like wl_display are different objects in each of them. I made these into two appendixes because the protocol spec was already an appendix. Reviewed-by: Bryce Harrington <b.harrington@samsung.com> [Bryce requested minor changes, not yet here.] Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: fix doxygen->man command lineBill Spitzak2014-12-161-2/+7
| | | | | | | | It was telling it to scan the doxyfile as well as the C source, and listing some source files more than once. Reviewed-by: Bryce Harrington <b.harrington@samsung.com> Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: Minor makefile cleanup.Jon A. Cruz2014-12-161-7/+13
| | | | | | | | Split out directory creation to leverage order only prerequisites. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: General makefile cleanup.Jon A. Cruz2014-12-161-31/+46
| | | | | | | | | | | | | | | This is a general cleanup of the makefile in order to bring it more inline with standard make practices. Cleanups included more use of automatic variables, switching AM_V_GEN to AM_V_at to have one 'GEN' visible per file, splitting copy operations to proper rules, and using order only dependencies to properly create directories on-demand. Changes also correct missing use of $(builddir) that has gone unnoticed as it defaults to the current directory ('.'). Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: Remove duplicated descriptions of wayland objectsBill Spitzak2014-12-051-11/+5
| | | | | | | | This text is a duplicate of the text in the protocol documentation, but the converter mangled it by removing the paragraph breaks and some other errors. Instead replace it with a list of links to the protocol docs. Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: removed redundant dependencyBill Spitzak2014-12-051-2/+2
| | | | | | | The .tmp file dependency depends on the index.xml file so it does not need to be repeated. Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Invoke doxygen via the defined make variable.Jon A. Cruz2014-12-051-3/+3
| | | | | | | | Invoke doxygen via the autoconf-defined make variable instead of directly. This brings it in line with standard makefile practices. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Removed redundant xslt output elements.Jon A. Cruz2014-12-012-2/+0
| | | | | | | | | Removed <xsl:output> elements that were duplicated but with attributes in a different order. Standard tools are required to ignore the order of attributes in an element. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: removed some unnecessary nested listing from doxygen outputBill Spitzak2014-11-251-20/+8
| | | | | This makes the lists of parameters slightly smaller and removes some bullets from see-also and since.
* doc: Don't print dash if doxygen brief description missingBill Spitzak2014-11-251-3/+5
|
* doc: preserve links produced by DoxygenBill Spitzak2014-11-252-15/+9
| | | | | | | | These links are pretty useful for navigation, though sometimes excessive (you can turn them off by putting % before the word in the comment). I had to turn off validation because it failed on missing and duplicate target id's, which this produces.
* doc: Preserve spacesBill Spitzak2014-11-251-0/+4
| | | | Slight variation on Pekka's patch. It seems harmless to put this anywhere.
* doc: make rebuilds doxygen output on code changesBill Spitzak2014-11-251-1/+1
| | | | Reviewed-by: Bryce Harrington <b.harrington@samsung.com>
* doc: Translate doxygen <sp/> tags to spacesBenjamin Herr2014-11-031-0/+4
| | | | | | | Doxygen represents all spacing in code blocks with <sp/> tags, so these need to be turned back into spaces. Signed-off-by: Benjamin Herr <ben@0x539.de>
* doc: Mostly use apply-templates over value-ofBenjamin Herr2014-11-031-16/+14
| | | | | | | xsl:value-of would strip all the nested markup of the selected doxygen elements, so that \ref, \sa and \code formatting didn't actually work. Signed-off-by: Benjamin Herr <ben@0x539.de>
* doc: replace publican with xmltoPeter Hutterer2014-09-227-43/+1952
| | | | | | | | | | | | | | | | | | | | | | | | | | Publican isn't packaged for some distros, xmlto is a lot more common. Most of what publican provides for us is the stylesheet anyway, so we can just use xmlto and the publican stylesheet to get roughly the same look. PDF and XML generation has been dropped, this needs a bit more more effort than a mere switchover to xmlto. The top-level directory structure imposed by publican is kept for now (specifically the Wayland/en-US/html tree). This makes it easier to transition over for packagers. Note that the list of files inside has changed. CSS files are taken from publican to keep a uniform look compared to previous documentations. Stylesheets are licensed under CC0 1.0 Universal license, see publican/LICENSE: 1. Files in the datadir/Common_Content directory and its subdirectories are licensed under the CC0 1.0 Universal license. To the extent possible under law, the developers of Publican waive all copyright and related or neighboring rights to the files contained in the datadir/Common_Content directory and its subdirectories. Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: Quell warnings about missing man3 directory before its been builtBryce W. Harrington2014-09-051-1/+1
| | | | | | | | | | | | | | | | | | | | | | | The shell command for dist_man3_MANS gets invoked several times during the make process but before the man pages have been generated, which causes the following warnings when running `make`: find: `man/man3': No such file or directory find: `man/man3': No such file or directory find: `man/man3': No such file or directory GEN xml/client/index.xml Despite these error messages, the generated dist tarball contains the man3 pages as intended, both before and after this patch. $ make dist $ tar xxf wayland-1.5.90.tar.xz $ find wayland-1.5.90/doc/doxygen/man/man3 -name "wl_*.3" | wc -l 85 Signed-off-by: Bryce Harrington <b.harrington@samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Tested-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc/publican: stop excessive rebuildsPeter Hutterer2014-09-031-14/+11
| | | | | | | | | | Traced down to the server/client target always rebuilding, causing a rebuild of everything else. Rework this so the target name is a file we actually produce and can check for a timestamp. Note: this also changes the generated file from the doxygen directory into the en-US publican path and renames it to (server|client)API.xml.tmp to avoid copying it into the xml output directory.
* doc: force publican to use fopPeter Hutterer2014-07-061-1/+1
| | | | | | Because wkhtmltopdf requires a $DISPLAY, and a patched Qt. https://bugzilla.redhat.com/show_bug.cgi?id=997682
* doc: reduce chunk_section_depth to 0Peter Hutterer2014-07-061-1/+1
| | | | One html page per chapter.
* doc: Remove obsolete doxygen tagsBoyan Ding2014-05-121-12/+0
|
* doc: Remove deprecated doxygen tagJonas Ådahl2014-05-091-16/+0
| | | | Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
* build: hide doxygen commands with AM_V_GENPekka Paalanen2014-03-101-3/+3
| | | | | | | I suppose the purpose was to print just one GEN line for each doxygen rule being executed, not print the doxygen command. Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: do not rebuild man pages if they are up to datePekka Paalanen2014-03-101-2/+2
| | | | | | | | The doxygen.man make target was not a real file that was generated, therefore the man page rule was ran on every make invocation. Replace it with a real file that is produced by the man page rule. Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* Add documentation for wl_shm_buffer_begin/end_accessNeil Roberts2013-11-151-1/+2
| | | | | It's not obvious that these functions are needed so it would be good to have some documentation for them.
* doc: Create \comment alias for C-style commentsAaron Faanes2013-09-211-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | Since /* */ do not nest, documentation is forced to either use C++ style // comments or some other foreign notation. This commit provides an alias that allows C-style comments to be introduced in code blocks that support aliases. It should be noted that this macro will not work within \code blocks, as Doxygen commands are ignored there. Instead, Doxygen's fenced code blocks (created via ~~~) must be used for proper output. To demonstrate: ~~~ struct example_node { int id; \comment{Other members ...} }; ~~~ will roughly yield the following HTML (excluding syntax highlighting): <pre> struct example_node { int id; /* Other members ... */ }; </pre>
* doc: Include wayland-util.* for doxygen outputAaron Faanes2013-09-161-0/+6
| | | | | | This commit creates a shared file list that is included by both the client and the server for the XML Makefile targets, as classes within util are used by both the client and the server.
* doc: Add a section on interface and protocol object versioningJason Ekstrand2013-08-191-0/+61
| | | | | | | | There have been a lot of questions asked lately about versioning of interfaces and protocol objects. This addition to the documentation should clear up some of those questions. Signed-off-by: Jason Ekstrand <jason@jlekstrand.net>
* doc: Update the ID alocation sectionJason Ekstrand2013-08-191-4/+10
| | | | | | | | The method described of alocation IDs has been wrong at least since version 1.0. This commit updates it to correspond to the way IDs are chosen in versions >= 1.0. Signed-off-by: Jason Ekstrand <jason@jlekstrand.net>
* publican: only split chapters and top-level sections onto separate pagesPeter Hutterer2013-08-151-0/+1
| | | | | | | When generating HTML, don't split once we're into subjections. This generates a single page for each protocol interface instead of the previous separate pages for requests, events and enums. No effect on the rest of the HTML configuration.
* publican: Fix grammar several places in Protocol docsBryce W. Harrington2013-08-081-5/+5
| | | | Signed-off-by: Bryce Harrington <b.harrington@samsung.com>
* publican: Drop unneeded 'of'Bryce W. Harrington2013-08-081-1/+1
| | | | Signed-off-by: Bryce Harrington <b.harrington@samsung.com>
generated by cgit v1.3.1 (git 2.54.0) at 2026-09-04 17:13:41 +0000