From 8736f61579e7b1771bf53039a1041caccee98892 Mon Sep 17 00:00:00 2001 From: Thomas Thurman Date: Mon, 18 Aug 2008 10:25:17 +0000 Subject: [PATCH] Adding doxygen headers to some files. 2008-08-18 Thomas Thurman Adding doxygen headers to some files. * src/core/metacity-Xatomtype.h * src/core/main.c * src/core/screen-private.h * src/core/window-private.h * src/core/keybindings.h * src/core/session.h * src/core/workspace.h * src/core/window-props.h () svn path=/trunk/; revision=3818 --- ChangeLog | 13 +++++++++++++ src/core/keybindings.h | 7 ++++++- src/core/main.c | 7 ++++--- src/core/metacity-Xatomtype.h | 18 +++++++++--------- src/core/screen-private.h | 9 ++++++++- src/core/session.h | 9 ++++++++- src/core/window-private.h | 9 ++++++++- src/core/window-props.h | 2 +- src/core/workspace.h | 10 +++++++++- 9 files changed, 66 insertions(+), 18 deletions(-) diff --git a/ChangeLog b/ChangeLog index 37e544e19..78ae1f5dc 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,16 @@ +2008-08-18 Thomas Thurman + + Adding doxygen headers to some files. + + * src/core/metacity-Xatomtype.h + * src/core/main.c + * src/core/screen-private.h + * src/core/window-private.h + * src/core/keybindings.h + * src/core/session.h + * src/core/workspace.h + * src/core/window-props.h () + 2008-08-18 Eric Piel * src/core/workspace.c (ensure_work_areas_validated): add a copy of diff --git a/src/core/keybindings.h b/src/core/keybindings.h index 137fceaee..618520b40 100644 --- a/src/core/keybindings.h +++ b/src/core/keybindings.h @@ -1,6 +1,11 @@ /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ -/* Metacity Keybindings */ +/** + * \file keybindings.h Grab and ungrab keys, and process the key events + * + * Performs global X grabs on the keys we need to be told about, like + * the one to close a window. It also deals with incoming key events. + */ /* * Copyright (C) 2001 Havoc Pennington diff --git a/src/core/main.c b/src/core/main.c index 23ab8e568..ee5245858 100644 --- a/src/core/main.c +++ b/src/core/main.c @@ -23,14 +23,15 @@ */ /** - * \file core/main.c Program startup - * + * \file + * Program startup. * Functions which parse the command-line arguments, create the display, * kick everything off and then close down Metacity when it's time to go. */ /** - * \mainpage Metacity - a boring window manager for the adult in you + * \mainpage + * Metacity - a boring window manager for the adult in you * * Many window managers are like Marshmallow Froot Loops; Metacity * is like Cheerios. diff --git a/src/core/metacity-Xatomtype.h b/src/core/metacity-Xatomtype.h index ff33cbe0e..d14d3ab72 100644 --- a/src/core/metacity-Xatomtype.h +++ b/src/core/metacity-Xatomtype.h @@ -1,6 +1,14 @@ /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ -/* $Xorg: Xatomtype.h,v 1.4 2001/02/09 02:03:38 xorgcvs Exp $ */ +/** + * \file metacity-Xatomtype.h Types for communicating with X about properties + * + * This files defines crock C structures for calling XGetWindowProperty and + * XChangeProperty. All fields must be longs as the semantics of property + * routines will handle conversion to and from actual 32 bit objects. If your + * compiler doesn't treat &structoflongs the same as &arrayoflongs[0], you + * will have some work to do. + */ /*********************************************************** @@ -52,14 +60,6 @@ SOFTWARE. #ifndef _XATOMTYPE_H_ #define _XATOMTYPE_H_ -/* - * This files defines crock C structures for calling XGetWindowProperty and - * XChangeProperty. All fields must be longs as the semantics of property - * routines will handle conversion to and from actual 32 bit objects. If your - * compiler doesn't treat &structoflongs the same as &arrayoflongs[0], you - * will have some work to do. - */ - #define BOOL long #define SIGNEDINT long #define UNSIGNEDINT unsigned long diff --git a/src/core/screen-private.h b/src/core/screen-private.h index f03fd7093..d9de2f534 100644 --- a/src/core/screen-private.h +++ b/src/core/screen-private.h @@ -1,6 +1,13 @@ /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ -/* Metacity X screen handler */ +/** + * \file screen-private.h Screens which Metacity manages + * + * Managing X screens. + * This file contains methods on this class which are available to + * routines in core but not outside it. (See screen.h for the routines + * which the rest of the world is allowed to use.) + */ /* * Copyright (C) 2001 Havoc Pennington diff --git a/src/core/session.h b/src/core/session.h index c9a742523..62a9370d1 100644 --- a/src/core/session.h +++ b/src/core/session.h @@ -1,6 +1,13 @@ /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ -/* Metacity Session Management */ +/** + * \file session.h Session management + * + * Maps windows to information about their placing and state on startup. + * This is window matching, which we have a policy of leaving in general + * to programs such as Devil's Pie, but the session manager specification + * requires us to do it here. + */ /* * Copyright (C) 2001 Havoc Pennington diff --git a/src/core/window-private.h b/src/core/window-private.h index bfe950a8a..73b780237 100644 --- a/src/core/window-private.h +++ b/src/core/window-private.h @@ -1,6 +1,13 @@ /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ -/* Metacity X managed windows */ +/** + * \file window-private.h Windows which Metacity manages + * + * Managing X windows. + * This file contains methods on this class which are available to + * routines in core but not outside it. (See window.h for the routines + * which the rest of the world is allowed to use.) + */ /* * Copyright (C) 2001 Havoc Pennington diff --git a/src/core/window-props.h b/src/core/window-props.h index 34721661d..9ac3cf19b 100644 --- a/src/core/window-props.h +++ b/src/core/window-props.h @@ -1,7 +1,7 @@ /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ /** - * \file window-props.c MetaWindow property handling + * \file window-props.h MetaWindow property handling * * A system which can inspect sets of properties of given windows * and take appropriate action given their values. diff --git a/src/core/workspace.h b/src/core/workspace.h index 948af74a4..f4079ebb1 100644 --- a/src/core/workspace.h +++ b/src/core/workspace.h @@ -1,6 +1,14 @@ /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ -/* Metacity Workspaces */ +/** + * \file workspace.h Workspaces + * + * A workspace is a set of windows which all live on the same + * screen. (You may also see the name "desktop" around the place, + * which is the EWMH's name for the same thing.) Only one workspace + * of a screen may be active at once; all windows on all other workspaces + * are unmapped. + */ /* * Copyright (C) 2001 Havoc Pennington