Commit graph

8 commits

Author SHA1 Message Date
Matthias Clasen
49e2d5af76 docs: Reorder some sections
Move the 'Types of Compositors' section right after the Overview,
and move the 'Client API' part after the protocol spec.
2013-04-01 17:40:13 -04:00
Tiago Vignatti
e2db4cf26f doc: Add auto-generated Wayland Library chapter
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>
2012-10-15 13:02:04 -04:00
Tiago Vignatti
29c20e2eb6 doc: Remove superfluous 'index'
We're not setting any sort of index. Remove for now.

Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-10-15 11:45:57 -04:00
Peter Hutterer
f68e156b8f doc: consistently indent the xml files by 2 spaces
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>
2012-03-28 23:05:45 -04:00
Peter Hutterer
966e8ec9c0 doc: rename Procotol to ProtocolSpec and WaylandProtocol to Protocol
The former is the actual specification, the latter notes about the protocol.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-03-28 23:05:32 -04:00
Peter Hutterer
adf300dc13 doc: remove unused example files
These files were left in as examples, we have real-world examples now.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-03-28 23:05:14 -04:00
Peter Hutterer
3d7f7e2f4a doc: move documentation from the tex file to docbook
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>
2012-03-28 23:04:25 -04:00
Gaetan Nadon
7ee21abef0 publican: support out-of-source tree build
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>
2012-03-04 15:02:43 -05:00
Renamed from doc/Wayland/en-US/Wayland.xml (Browse further)