Skip to content

Commit

Permalink
Docs: update class docs
Browse files Browse the repository at this point in the history
no logic changes
  • Loading branch information
Tony Crisci committed Oct 13, 2014
1 parent 4fb9595 commit 0b5e19f
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
11 changes: 9 additions & 2 deletions i3ipc-glib/i3ipc-con.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,16 @@

/**
* SECTION: i3ipc-con
* @short_description: A representation of an i3 window container.
* @short_description: A node in the i3 window container tree, including
* outputs, workspaces, split containers, and top-level windows (leaves).
*
* #i3ipcCon is a class to model a node in the i3 window container tree.
* #i3ipcCon is a node in the i3 window container tree. Cons are created by the
* #i3ipcConnection for queries and on events. This class contains properties
* of the window in the i3 tree. Containers include outputs, workspaces, split
* containers, and top-level windows (leaves). You can use the class methods to
* query containers within the given container based on certain window
* properties, retrieve all the leaves under the container, or execute commands
* in the context of the container.
*/

#define I3IPC_TYPE_CON (i3ipc_con_get_type ())
Expand Down
8 changes: 6 additions & 2 deletions i3ipc-glib/i3ipc-connection.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,13 @@

/**
* SECTION: i3ipc-connection
* @short_description: A connection to the i3 IPC.
* @short_description: A connection to the i3 ipc to query i3 for the state of
* containers and to subscribe to window manager events.
*
* Use this class to query information from the window manager about the state
* of the workspaces, windows, etc. You can also subscribe to events such as
* when certain window or workspace properties change.
*
* The #i3ipcConnection is a class to send messages to i3.
*/

#define I3IPC_TYPE_CONNECTION (i3ipc_connection_get_type ())
Expand Down

0 comments on commit 0b5e19f

Please sign in to comment.