summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* publican: Cleanup Preface's grammar.Bryce W. Harrington2013-08-081-7/+6
| | | | Signed-off-by: Bryce Harrington <b.harrington@samsung.com>
* doc: Add a small contributing guideAnder Conselvan de Oliveira2013-06-182-0/+85
| | | | | | Document what we expect in terms of commit messages and coding style. New contributors are usually unaware of this, so it is good to have a document to point them too.
* protocol: Fix documentation typoPeng Wu2013-05-221-1/+1
|
* docs: Create html-pdf directories tooKristian Høgsberg2013-04-151-0/+3
| | | | Fixes make dist here.
* doc: use a dynamic list of man pages1.0.90Peter Hutterer2013-04-041-51/+6
| | | | | | | This requires that doxygen is run before the man target so find can actually find the man pages. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Improve "Library" and "Compositors" chapterPeter Hutterer2013-04-042-1/+35
| | | | | | | | | Originally written Tiago Vignatti <tiago.vignatti@intel.com> Some modifications to adjust for previously merged conflicting patches and link to the sections (instead of <emphasis>). Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: create a fake make target to de-duplicate the xml merging processPeter Hutterer2013-04-041-21/+16
| | | | | | | | The only difference between the server and client xml files is the directories and files being named *server* and *client*, respectively. Add a new make target to get that process done to avoid duplication Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: generate server documentation from XML tooPeter Hutterer2013-04-045-22/+50
| | | | | | | | | | | | Same as WaylandClientAPI.xml we now also generate WaylandServerAPI.xml for publication. Most of this hunk is just adding a client/ or server/ into the xml path to keep the two separate. The change in wayland.doxygen now causes a standard doxygen call to not generate anything - what is generated is specified through the options passed by make. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Capitalize all Wayland occurrencesTiago Vignatti2013-04-045-19/+19
| | | | | | | | | Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com> Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net> [re-run of search/replace after rebasing] Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* docs: Use MIT for documentation licenseKristian Høgsberg2013-04-031-1/+33
|
* doc: rename "Wayland" to "publican"Peter Hutterer2013-04-0323-1/+1
| | | | | | | | | This directory was called Wayland during my early tries with publican where the source layout was different and it needed to be set to the same name as the publican output directory. This reason doesn't exist anymore, so re-name it to publican to make it more obvious what's hiding in here. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: generate man pages from doxygenPeter Hutterer2013-04-032-5/+72
| | | | | | | | | | | | | | | | | | | | | | | | Create client-side and server-side man pages from doxygen. The doxygen config options are virtually the same as for the XML output, but we do pass in the specific options via stdin. WL_EXPORT is predefined to the empty string, it makes the man page look confusing and provides no value here anyway. This applies for both xml and man output. JAVADOC_AUTOBRIEF is disabled for man pages, the formatting in the resulting man page is IMO hard to read. Most of the server man pages are virtually empty, there's just not enough documentation in the source files. Interesting issue: the usage of @code in the protocol to reference the parameter breaks the expansion of WL_EXPORT, thus leaving us with WL_EXPORT in all the man pages. Presumably this is an issue with doxygen interpreting this as a @code command, but I already wasted enough time narrowing this down. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: don't start a variable list if we have no sub-elementsPeter Hutterer2013-04-031-5/+7
| | | | Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: improve formatting of client-side documentationPeter Hutterer2013-04-031-3/+92
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | A bunch of changes to the xsl transformation stylesheet to make Chapter 4 (Client API) look nicer and more readable. Main changes: - function synopsis listed - lists for parameters and return values - long function descriptions - misc other hooks for "see also", "note", etc The long description is a sore point. doxygen xml output is difficult to parse with the output being in the form of <detailed description> <para> <parameterlist> .... </parameterlist> <simplesect kind="return">... </simplesect> First paragraph of long description </para> <para> Second paragraph of long <sometag>description</sometag> </para> </detaileddescription> So we need to ignore parameterlist and simplesect, but extract the text from everything else. Any improvements on that welcome. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: change wording in section introductionPeter Hutterer2013-04-031-1/+1
| | | | | | If we don't have descriptions of classes, the "And" is awkward. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: add wayland.doxygen as target dependencyPeter Hutterer2013-04-031-1/+1
| | | | Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* Rename en_US to sourcesPeter Hutterer2013-04-0317-20/+20
| | | | | | | | | | | | The reason this directory exists is because we need to copy it into $builddir so we can combine it with generated sources (we can't pass multiple source paths into publican). So instead of having en_US, renamed to en-US stop the confusion and rename the sources to "sources". That gets copied to en-US which will then contain the actual output. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: explain the publican build processPeter Hutterer2013-04-031-0/+17
| | | | | | | | This makefile is a bit hard to read due to some publican requirements and the need to generate some files through XSLT. Explain the lot, so that those looking at this roughly know what will hit them. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: clarify how ClientAPI.xml is builtPeter Hutterer2013-04-031-3/+6
| | | | | | | I found the comment a bit confusing and it's quite hard to read. re-explain with a simple step-by-step list Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Format Chapter 4 paragraphs correctlyTiago Vignatti2013-04-031-2/+3
| | | | Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* doc: minor title wording fixPeter Hutterer2013-04-031-1/+1
| | | | Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Change chapter title to a more descriptive oneTiago Vignatti2013-04-031-1/+1
| | | | | | Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com> Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Rename Overview.xml to Introduction.xmlTiago Vignatti2013-04-033-6/+6
| | | | | | | | | Rename Overview.xml to Introduction.xml, reflecting the previous commit. Organize also Wayland.xml order of the includes. Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com> Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Improve the first chapter text and definitionsTiago Vignatti2013-04-031-22/+9
| | | | | | | | | | | | | | In the beginning of the chapter, it was defined what is the so called "X" thing and was removed the "Wayland" and "Weston" definitions cause we're defining later at 1.2 anyway. "Introduction", "Motivation" and "Compositing manager as the display server" names sound better a bit than "Overview", "Replacing X11" and "Make the compositing manager the display server" respectively. That was changed also. Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com> Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Set book edition number to the "1"Tiago Vignatti2013-04-031-1/+1
| | | | | | | | | | | | | "1" sounds better when we mention about the "first" edition or say the "publishing" edition. If needed, we might want to increase the edition numbers automatically later, for instance based on the micro version of the protocol or something like that. Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com> Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Add a Foreword and a PrefaceTiago Vignatti2013-04-034-0/+53
| | | | | | | | | In particular, the preface defines the scope of this document we're building -- is the definition there enough with respect to what we want with this? Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com> Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: don't add a para for an empty summaryPeter Hutterer2013-04-031-3/+5
| | | | | | Removes enough empty lines to cut the PDF down by 4 pages. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* docs: Add information about serials and timestampsMatthias Clasen2013-04-011-0/+16
| | | | | Add some information about serials, timestamps and their uses to the Input section in the protocol overview.
* docs: Add details about grabsMatthias Clasen2013-04-011-0/+8
| | | | | Mention implicit grabs, (lack of) explicit grabs, and popup windows.
* docs: Add details about surfacesMatthias Clasen2013-04-011-0/+2
| | | | | Mention some of the characteristic differences to X: no global positions, no access to foreign windows.
* docs: Consistency fixesMatthias Clasen2013-04-011-3/+3
| | | | Say 'object ID' throughout.
* doc: Improve various sections of the documentationMatthias Clasen2013-04-011-40/+31
|
* docs: Improve the 'Connect time' sectionMatthias Clasen2013-04-011-15/+4
| | | | Turn the bullet-point list into complete sentences.
* docs: Improve the 'Types of Compositors' sectionMatthias Clasen2013-04-011-73/+46
| | | | Turn the bullet-point lists into full paragraphs.
* docs: Slight rewordingMatthias Clasen2013-04-011-1/+1
| | | | | The Wayland Protocol -> Wayland Protocol Overview, to align better with the subsequent Wayland Protocol Specification.
* docs: Reorder some sectionsMatthias Clasen2013-04-011-2/+2
| | | | | Move the 'Types of Compositors' section right after the Overview, and move the 'Client API' part after the protocol spec.
* docs: Fix the documentation buildMatthias Clasen2013-03-281-1/+1
| | | | | The publican man page says that the options are actually called --formats and --langs, and with this, the doc build succeeds.
* docs: Add a revision historyMatthias Clasen2013-03-282-0/+8
| | | | Publican complains if it can't find this file.
* Make sure that man page xml files are always distedArmin K2013-02-141-4/+3
|
* man, configure.ac: Only generate man pages if we can do it offlineJonas Ådahl2012-12-031-2/+5
| | | | | | | | Instead of relying on downloading the stylesheet from the Internet for generating man pages, only generate them if the stylesheet is available locally. Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
* doc: Only generate Wayland documentation if xsltproc was foundJonas Ådahl2012-12-031-0/+2
| | | | | | | Instead of failing to generate documentation because xsltproc doesn't exist, don't try to generate at all. Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
* doc: Fix out-of-source build so distcheck works againKristian Høgsberg2012-11-191-7/+7
| | | | | | The amount of generated files and hacks over hacks in the doc/ directory is getting out of hand and we need a better solution. For now, just get distcheck back to working.
generated by cgit v1.2.3-70-g09d2 (git 2.52.0) at 2026-01-04 22:50:15 +0000