summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* doc: Fix incorrectly formatted section headerTiago Vignatti2012-11-121-1/+3
| | | | | | | https://bugs.freedesktop.org/show_bug.cgi?id=56719 Reported-by: Petr Gladkikh <PetrGlad@gmail.com> Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* doc: Update .gitignoreTiago Vignatti2012-11-122-0/+2
| | | | Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* doc: Set publican to quiet modeTiago Vignatti2012-11-121-1/+1
| | | | Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* doc: Auto-generate API methods and classes documentationTiago Vignatti2012-11-122-16/+52
| | | | | | | | There's work to do still for giving a prettier style on the documentation, for instance splitting paragraphs correctly and printing the detailed description of the methods as well. Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* doc: doxygen: Interpret the first line comment as the briefTiago Vignatti2012-11-121-1/+1
| | | | Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* doc: Remove obsolete doxygen tagsKristian Høgsberg2012-10-291-17/+0
| | | | https://bugs.freedesktop.org/show_bug.cgi?id=56377
* doc: Fix typo in generated section headerKristian Høgsberg2012-10-211-2/+2
| | | | | We were generating headers such as 'Events provided by wl_display events', drop the last 'events'.
* doc: Update doxygen documentation when source files are changedAnder Conselvan de Oliveira2012-10-191-1/+5
|
* docs: Make distcheck happyKristian Høgsberg2012-10-151-8/+10
| | | | | publican doesn't seem to be a very well-behaved tool and needs a bit of hacking to work well for both in-tree and out-of-tree builds.
* doc: doxygen: Add .gitignoreTiago Vignatti2012-10-151-0/+1
| | | | Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* doc: Add some doxygen documentation to wayland-client entry pointsAnder Conselvan de Oliveira2012-10-151-1/+2
| | | | | | | | | Add some brief documentation for the public libwayland-client entry points. This is by no means complete, some functions are still undocumented and some might need extra information. Signed-off-by: Ander Conselvan de Oliveira <ander.conselvan.de.oliveira@intel.com> Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* doc: Split protocol description paragraphs properlyAnder Conselvan de Oliveira2012-10-151-4/+25
| | | | | | | | | | The xsl translation from the protocol xml to publican would create only one paragraph for all the text in a description. Make it generate one paragraph for each block of text separated by two consecutive line breaks instead. Signed-off-by: Ander Conselvan de Oliveira <ander.conselvan.de.oliveira@intel.com> Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* doc: Add auto-generated Wayland Library chapterTiago Vignatti2012-10-157-5/+1857
| | | | | | | | | | | For now only Wayland Client API is described on that chapter, which is extracted via doxygen on ./src/wayland-client.h. We apply a stylesheet (doxygen-to-publican) on doxygen output so it becomes docbook valid. Now all we need to do is populate that header while developing in order to grow a decent documentation. So please use it! Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* doc: Remove superfluous 'index'Tiago Vignatti2012-10-151-1/+0
| | | | | | We're not setting any sort of index. Remove for now. Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* doc: publican: Automate version generationTiago Vignatti2012-10-151-1/+6
| | | | | | It seems reasonable to use protocol's version for the documentation as well. Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* doc: publican: Set table of contents depth to 1Tiago Vignatti2012-10-151-1/+1
| | | | | | | This way looks more pretty, in particular for the Appendix which spawns a big subsections chain. Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* doc: Update drag and drop section and add info about selectionsAnder Conselvan de Oliveira2012-10-101-160/+99
| | | | | | Replace the outdated section about drag and drop support with a rewritten section covering the data source/offer mechanism and wl_data_device, explaining how selection and drag ang drop works.
* doc: Remove Shared Object Cache sectionTiago Vignatti2012-10-091-55/+0
| | | | | | We don't support anything like that yet. Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* doc: Auto-generate Protocol/Interfaces section insteadTiago Vignatti2012-10-093-128/+66
| | | | Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* doc: Improve Wire Format sectionTiago Vignatti2012-10-091-5/+17
| | | | | | Fixed the wayland socket name and added documentation for fixed format. Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
* man: fix compilation without xsltprocDavid Herrmann2012-09-261-5/+9
| | | | | | | | | We really shouldn't add the man-pages when HAVE_XSLTPROC is not true so move it into the if-clause. But declare the automake-variables outside of the if-clause to avoid automake complaints. Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
* man: add man-page infrastructureDavid Herrmann2012-09-253-1/+134
| | | | | | | | | | | | | | | | | | This adds a man-page infrastructure based on Docbook XML files. This allows us to integrate the man-pages into the publican books later. An example page for wl_display_connect() (with an alias wl_display_connect_to_fd()) is also added. Feel free to add more man-pages. Function calls are put in man3 and overview pages into man7. All pages (including aliases) have to be added to the Makefile. Docbook does generate aliases automatically from the additional names that were put in the XML file. However, a small SED script is needed to fixup the include-paths in the generated troff files. If someone knows how to avoid that (or even install them gzip'ped), please fix it up. Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
* Fix grammar in the rendering section.Christopher Michael2012-08-131-1/+1
| | | | | Upon reading some docs, I found a small grammar mistake in the rendering section. This patch fixes that.
* Make distcheck work from builddir configured with --disable-documentationKristian Høgsberg2012-07-241-6/+6
|
* doc: fix some typos in documentationMartin Olsson2012-07-091-2/+2
|
* doc: Update docs to refer to wl_seat instead of wl_input_deviceKristian Høgsberg2012-05-161-2/+2
|
* Add missing alt attributes in publican docs.Darxus2012-05-153-0/+25
| | | | | | Haven't figured out how to regenerate the html, so it's not tested. Looks like remaining html errors will be fixed in the next publican release: https://bugzilla.redhat.com/show_bug.cgi?id=788576
* docs: Touch ouput dir Wayland to update timestampKristian Høgsberg2012-03-291-0/+1
| | | | Prevents rebuild every time.
* doc: consistently indent the xml files by 2 spacesPeter Hutterer2012-03-285-383/+383
| | | | | | | 2 spaces is enough for xml, otherwise we end up with too little room for the actual text. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: rename Procotol to ProtocolSpec and WaylandProtocol to ProtocolPeter Hutterer2012-03-284-30/+30
| | | | | | The former is the actual specification, the latter notes about the protocol. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: remove unused example filesPeter Hutterer2012-03-285-80/+0
| | | | | | These files were left in as examples, we have real-world examples now. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: move documentation from the tex file to docbookPeter Hutterer2012-03-285-0/+947
| | | | | | | | | | | | | And remove the .tex file Minor changes: - where the .tex file had some interface descriptions, the docbook source now links to the actual protocol. The exception here is the shared object cache which is simply a <programlisting> until the protocol spec exists. - "Implementation" section skipped, this seems in need of an update anyway and may be better documented elsewhere (wiki?) Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Don't list directories in list of files to installKristian Høgsberg2012-03-161-1/+1
| | | | | The find expression was listing the xml_tmp directory, because it matched the -prune rule.
* publican: support out-of-source tree buildGaetan Nadon2012-03-0414-39/+55
| | | | | | | | | | When srcdir!=builddir, there is no way to tell publican that the source is in srcdir rather than builldir. The workaround is to copy the source files from srcdir to builddir. To retain the en-US final destination name, the source directory is renamed to en_US. Tested-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
* Hack up distcheck for publicanPeter Hutterer2012-02-291-4/+18
| | | | | | | | | | | | Publican requires a read-write source tree, see http://bugzilla.redhat.com/show_bug.cgi?id=798484 And it currently cannot build out-of-tree, so we need to copy the sources into the _build tree and generate Protocol.xml into that tree too (we'd have to do this anyway since automake creates a read-only source tree, so we can't just link). Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* Generate the docbook description for the protocol from wayland.xmlPeter Hutterer2012-02-294-2/+122
| | | | | | | Convert the wayland.xml protocol description to a docbook-compatible format and hook it up to the publican sources. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* Hook up autotools for publicanPeter Hutterer2012-02-294-0/+39
| | | | | | | automake doesn't seem to provide a sensible method to install a directory of stuff in $(docdir). Do it manually then. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Comment out some of the default chaptersPeter Hutterer2012-02-291-0/+5
| | | | | | | I'll leave them in for now as a template for how things looked originally, this can be removed later. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Add architecture from the websitePeter Hutterer2012-02-294-0/+319
| | | | Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Fix up title page with logo and author informationPeter Hutterer2012-02-294-9/+16
| | | | | | Abstract taken from http://wayland.freedesktop.org Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: add publican-created doctreePeter Hutterer2012-02-299-0/+154
$> publican create --name=Wayland unmodified otherwise To build the tree to target formats, use $> publican build --langs=en-US --formats=html,pdf Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
generated by cgit v1.3.1 (git 2.54.0) at 2026-09-07 19:07:59 +0000