Add a more detailed description of some files.

6 files changed, 41 insertions, 19 deletions

diff --git a/src/miniglx/dispatch.c b/src/miniglx/dispatch.c
index 61b0e1ee7f..264cd4cba8 100644
--- a/src/miniglx/dispatch.c
+++ b/src/miniglx/dispatch.c
@@ -4,6 +4,13 @@
  * \brief C-based dispatch of the OpenGL entry points (glAccum(), glBegin(),
  * etc).
  * 
+ * \author Brian Paul <brian@precisioninsight.com>
+ * 
+ * \note This code IS NOT USED if we're compiling on an x86 system and using
+ * the glapi_x86.S assembly code.
+ */
+
+/* 
  * Copyright 1998-1999 Precision Insight, Inc., Cedar Park, Texas.
  * All Rights Reserved.
  * 
@@ -26,12 +33,6 @@
  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- * 
- * \author Brian Paul <brian@precisioninsight.com>
- * 
- * \note This code IS NOT USED if we're compiling on an x86 system and using
- * the glapi_x86.S assembly code.
- *
  */
 
 #include <GL/gl.h>
diff --git a/src/miniglx/dri_util.h b/src/miniglx/dri_util.h
index b7c22a3e77..7ac6bb8c1c 100644
--- a/src/miniglx/dri_util.h
+++ b/src/miniglx/dri_util.h
@@ -17,7 +17,9 @@
  * 
  * \author Kevin E. Martin <kevin@precisioninsight.com>
  * \author Brian Paul <brian@precisioninsight.com>
- *
+ */
+
+/*
  * Copyright 1998-1999 Precision Insight, Inc., Cedar Park, Texas.
  * All Rights Reserved.
  * 
diff --git a/src/miniglx/drm.h b/src/miniglx/drm.h
index 25ecbb1887..0bb9bd039d 100644
--- a/src/miniglx/drm.h
+++ b/src/miniglx/drm.h
@@ -2,6 +2,11 @@
  * \file drm.h 
  * \brief Header for the Direct Rendering Manager
  * 
+ * This file defines the DRM device ioctls and the strucutre of respective user
+ * arguments.
+ *
+ * \sa xf86drm.h and xf86drm.c for an user-friendlier interface.
+ * 
  * \author Rickard E. (Rik) Faith <faith@valinux.com>
  *
  * \par Acknowledgements:
diff --git a/src/miniglx/sarea.h b/src/miniglx/sarea.h
index 89de065b8a..47545e10e9 100644
--- a/src/miniglx/sarea.h
+++ b/src/miniglx/sarea.h
@@ -2,6 +2,17 @@
  * \file sarea.h 
  * \brief SAREA definitions.
  * 
+ * The SAREA is a memory region is shared by the DRM device, the X server and
+ * the clients.
+ *
+ * This file defines its layout in user space.
+ * 
+ * \author Kevin E. Martin <kevin@precisioninsight.com>
+ * \author Jens Owen <jens@tungstengraphics.com>
+ * \author Rickard E. (Rik) Faith <faith@valinux.com>
+ */
+
+/*
  * Copyright 1998-1999 Precision Insight, Inc., Cedar Park, Texas.
  * Copyright 2000 VA Linux Systems, Inc.
  * All Rights Reserved.
@@ -25,10 +36,6 @@
  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- * 
- * \author Kevin E. Martin <kevin@precisioninsight.com>
- * \author Jens Owen <jens@tungstengraphics.com>
- * \author Rickard E. (Rik) Faith <faith@valinux.com>
  */
 
 #ifndef _SAREA_H_
diff --git a/src/miniglx/xf86drm.c b/src/miniglx/xf86drm.c
index 078a8025eb..6842179ee3 100644
--- a/src/miniglx/xf86drm.c
+++ b/src/miniglx/xf86drm.c
@@ -2,8 +2,16 @@
  * \file xf86drm.c 
  * \brief User-level interface to DRM device
  *
- * Created: Tue Jan  5 08:16:21 1999 by faith@precisioninsight.com
- *
+ * This file is an user-friendly interface to the DRM ioctls defined in drm.h.
+ * 
+ * This covers only the device-independent ioctls -- it is up to the driver to
+ * wrap the device-dependent ioctls.
+ * 
+ * \author Rickard E. (Rik) Faith <faith@valinux.com>
+ * \author Kevin E. Martin <martin@valinux.com>
+ */
+
+/*
  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  * All Rights Reserved.
@@ -26,9 +34,6 @@
  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  * DEALINGS IN THE SOFTWARE.
- *
- * \author Rickard E. (Rik) Faith <faith@valinux.com>
- * \author Kevin E. Martin <martin@valinux.com>
  */
 
 # include <stdio.h>
diff --git a/src/miniglx/xf86drm.h b/src/miniglx/xf86drm.h
index dc92f32837..182dd6f783 100644
--- a/src/miniglx/xf86drm.h
+++ b/src/miniglx/xf86drm.h
@@ -2,8 +2,12 @@
  * \file xf86drm.h 
  * \brief OS-independent header for DRM user-level library interface
  *
- * Created: Tue Jan  5 08:17:23 1999 by faith@precisioninsight.com
+ * This file is an user-friendly interface to the DRM ioctls defined in drm.h.
  *
+ * \author Rickard E. (Rik) Faith <faith@valinux.com>
+ */
+
+/*
  * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  * All Rights Reserved.
@@ -26,8 +30,6 @@
  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  * DEALINGS IN THE SOFTWARE.
- *
- * \author Rickard E. (Rik) Faith <faith@valinux.com>
  */
 
 #ifndef _XF86DRM_H_