1. 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
  2. 20 Feb, 2016 1 commit
  3. 16 Nov, 2015 1 commit
  4. 04 Nov, 2015 2 commits
  5. 22 Sep, 2015 1 commit
  6. 24 Aug, 2015 1 commit
  7. 14 Aug, 2015 1 commit
    • Dima Ryazanov's avatar
      client: require WAYLAND_DISPLAY to be set · fb7e1302
      Dima Ryazanov authored
      Although defaulting to wayland-0 seems convenient, it has an undesirable
      side effect: clients may unintentionally connect to the wrong compositor.
      Generally, it's safer to fail instead. Here's a real example:
      
      In Fedora 22, Gtk+ prefers Wayland over X11, though the default session is still
      a normal X11 Gnome session. When you launch a Gtk+ app, it will try Wayland,
      fail, then try X11, and succesfully start up. That works fine.
      
      Now suppose you launch Weston while running the Gnome session. Suddenly, all
      of the Gtk+ apps launched from Gnome will show up inside Weston instead.
      That's unexpected. There's also no good way to prevent that from happening
      (other than perhaps setting WAYLAND_DISPLAY to an invalid value when launching
      an app).
      
      Not using wayland-0 as the default will solve that problem: an app launched
      from the X11 Gnome session will use the X11 backend regardless of whether
      there's a wayland compositor running at the same time.
      
      Everything else should work as before. The compositor already sets
      the WAYLAND_DISPLAY when starting the session, so the lack of the default value
      should not make a difference to the user.
      Signed-off-by: Dima Ryazanov's avatarDima Ryazanov <dima@gmail.com>
      Acked-by: Pekka Paalanen's avatarPekka Paalanen <ppaalanen@gmail.com>
      Acked-by: default avatarGiulio Camuffo <giuliocamuffo@gmail.com>
      Acked-by: Daniel Stone's avatarDaniel Stone <daniel@fooishbar.org>
      Acked-by: Jasper St. Pierre's avatarJasper St. Pierre <jstpierre@mecheye.net>
      Reviewed-by: default avatarRyo Munakata <ryomnktml@gmail.com>
      
      [Pekka: dropped the wayland-server.c hunk, adjusted summary]
      Signed-off-by: Pekka Paalanen's avatarPekka Paalanen <pekka.paalanen@collabora.co.uk>
      fb7e1302
  8. 22 Jun, 2015 1 commit
  9. 18 Jun, 2015 2 commits
  10. 12 Jun, 2015 1 commit
  11. 05 Jun, 2015 1 commit
  12. 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
  13. 19 Mar, 2015 1 commit
    • Bryce Harrington's avatar
      Spelling fixes (cosmetic) · 439b0a38
      Bryce Harrington authored
      A few typos in comments and protocol docs, no code changes.
      
      ./src/wayland-util.h:281: recieved  ==> received
      ./src/wayland-client.c:115: occured  ==> occurred
      ./src/wayland-client.c:156: occured  ==> occurred
      ./tests/test-compositor.c:76: parallely  ==> parallelly
      ./tests/test-compositor.c:474: recieve  ==> receive
      ./protocol/wayland.xml:1767: layed  ==> laid
      ./protocol/wayland.xml:2112: dependant  ==> dependent
      ./doc/publican/sources/Client.xml:25: recieved  ==> received
      Signed-off-by: default avatarBryce Harrington <bryce@osg.samsung.com>
      Reviewed-by: Bill Spitzak's avatarBill Spitzak <spitzak@gmail.com>
      439b0a38
  14. 05 Feb, 2015 1 commit
  15. 31 Jan, 2015 1 commit
  16. 30 Jan, 2015 1 commit
    • Bill Spitzak's avatar
      doc: Intro text for doxygen output in it's own file · 6be2d9aa
      Bill Spitzak authored
      (This patch has been modified to apply atop current master)
      
      This makes it considerably easier to edit the text and make it different
      for each library.
      
      To address previous concerns with this patch, I wrote some more complete
      introductory text. This is based on my understanding of these libraries, which
      may not be correct, and is pretty rudimentary for libwayland-server!
      
      However this intro text demonstrates how to create links to the
      doxygen-generated text. It looks like you cannot link to methods easily as the
      link name contains a hash number, but links to objects and classes work.
      Reviewed-by: default avatarJon A. Cruz <jonc@osg.samsung.com>
      Tested-by: default avatarJon A. Cruz <jonc@osg.samsung.com>
      6be2d9aa
  17. 29 Jan, 2015 4 commits
  18. 27 Jan, 2015 3 commits
  19. 24 Jan, 2015 3 commits
  20. 19 Dec, 2014 5 commits
  21. 18 Dec, 2014 3 commits
  22. 16 Dec, 2014 3 commits