1. 28 Nov, 2016 1 commit
    • Yong Bakos's avatar
      doc: Remove wayland-util.c from file list · deb370cc
      Yong Bakos authored
      Documentation generation via doxygen includes wayland-util.c in its file
      list. Although functions are documented in wayland-util.h, doxygen is
      not automatically using the same documentation for functions in
      wayland-util.c. In addition, everything listed in the doxygen page for
      wayland-util.c is documented in the page for wayland-util.h and the
      pages for corresponding structures. As such, the doxygen page for
      wayland-util.c has no value, and is redundant.
      
      Remove the doxygen page for wayland-util.c.
      Signed-off-by: default avatarYong Bakos <ybakos@humanoriented.com>
      Acked-by: Peter Hutterer's avatarPeter Hutterer <peter.hutterer@who-t.net>
      deb370cc
  2. 07 Mar, 2016 2 commits
    • Peter Hutterer's avatar
      doc: link between client and server doc and to the wayland book · 973a70db
      Peter Hutterer authored
      And insert "client" or "server" into the PROJECT_NAME to know which one we
      have.
      Signed-off-by: Peter Hutterer's avatarPeter Hutterer <peter.hutterer@who-t.net>
      Reviewed-by: default avatarBryce Harrington <bryce@osg.samsung.com>
      973a70db
    • Peter Hutterer's avatar
      doc: generate doxygen html output from the scanner · 2b5310a3
      Peter Hutterer authored
      This switches the scanner to generate doxygen-compatible tags for the
      generated protocol headers, and hooks up the doxygen build to generate server
      and client-side API documentation. That documentation is now in
      Client/ and Server/, respectively.
      
      GENERATE_HTML is on by default and must be disabled for the xml/man targets to
      avoid messing up the new documentation. We disable all three three targets in
      the doxyfile (xml and man default to NO anyway) to make it obvious that they
      need to be set in the per-target instructions.
      
      Each protocol is a separate doxygen @page, with each interface a @subpage.
      Wayland only has one protocol, wayland-protocols will have these nested.
      Each protocol page has a list of interfaces and the copyright and description
      where available.
      All interfaces are grouped by doxygen @defgroup and @ingroups and appear in
      "Modules" in the generated output. Each interface subpage has the description
      and a link to the actual API doc.
      Function, struct and #defines are documented in doxygen style and associated
      with the matching interface.
      
      Note that pages and groups have fixed HTML file names and are directly
      linkable/bookmark-able.
      
      The @mainpage is a separate file that's included at build time. It doesn't
      contain much other than links to where the interesting bits are. It's a static
      file though that supports markdown, so we can extend it easily in the future.
      
      For doxygen we need the new options EXTRACT_ALL and OPTIMIZE_OUTPUT_FOR_C so
      it scans C code properly. EXTRACT_STATIC is needed since most of the protocol
      hooks are static.
      Signed-off-by: Peter Hutterer's avatarPeter Hutterer <peter.hutterer@who-t.net>
      Reviewed-by: default avatarBryce Harrington <bryce@osg.samsung.com>
      2b5310a3
  3. 16 Nov, 2015 1 commit
  4. 30 Apr, 2015 1 commit
    • Giulio Camuffo's avatar
      introduce new headers wayland-client-core.h and wayland-server-core.h · d74a9c07
      Giulio Camuffo authored
      wayland-client.h and wayland-server.h include the protocol headers generated
      at build time. This means that a libwayland user cannot generate and use
      protocol code created from a wayland.xml newer than the installed libwayland,
      because it is not possible to only include the API header.
      
      Another use case is language bindings, which would generate their own protocol
      code and which only need to use the library ABI, not the generated C code.
      
      This commit adds wayland-client-core.h and wayland-server-core.h which do not
      include the protocol headers or any deprecated code.
      Reviewed-by: Jason Ekstrand's avatarJason Ekstrand <jason@jlekstrand.net>
      Reviewed-by: Pekka Paalanen's avatarPekka Paalanen <pekka.paalanen@collabora.co.uk>
      d74a9c07
  5. 31 Jan, 2015 1 commit
  6. 29 Jan, 2015 2 commits
  7. 18 Dec, 2014 1 commit
  8. 16 Dec, 2014 2 commits
  9. 05 Dec, 2014 1 commit
  10. 05 Sep, 2014 1 commit
  11. 10 Mar, 2014 2 commits
  12. 15 Nov, 2013 1 commit
  13. 17 Sep, 2013 1 commit
    • Aaron Faanes's avatar
      doc: Include wayland-util.* for doxygen output · 2e3af5e5
      Aaron Faanes authored
      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.
      2e3af5e5
  14. 04 Apr, 2013 2 commits
  15. 03 Apr, 2013 2 commits
    • Peter Hutterer's avatar
      doc: generate man pages from doxygen · 8ccab1ba
      Peter Hutterer authored
      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's avatarPeter Hutterer <peter.hutterer@who-t.net>
      8ccab1ba
    • Peter Hutterer's avatar
      ed2f8d38
  16. 19 Oct, 2012 1 commit
  17. 15 Oct, 2012 1 commit
    • Tiago Vignatti's avatar
      doc: Add auto-generated Wayland Library chapter · e2db4cf2
      Tiago Vignatti authored
      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: default avatarTiago Vignatti <tiago.vignatti@intel.com>
      e2db4cf2