Adding doxygen headers to some files.

2008-08-18  Thomas Thurman  <tthurman@gnome.org>

        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

@@ -1,3 +1,16 @@
+2008-08-18  Thomas Thurman  <tthurman@gnome.org>
+
+        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  <e.a.b.piel@tudelft.nl>
 
         * src/core/workspace.c (ensure_work_areas_validated): add a copy of

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

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.

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

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

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

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

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.

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