diff options
| author | Nathan Letwory <nathan@letworyinteractive.com> | 2011-02-17 08:57:18 +0300 |
|---|---|---|
| committer | Nathan Letwory <nathan@letworyinteractive.com> | 2011-02-17 08:57:18 +0300 |
| commit | f336b80d7f142121edc21f3bd77a9e241f1aecaa (patch) | |
| tree | ca87c79d5469f1fa3698172f9e0972581c2a795e /intern | |
| parent | 812f23849422e50b2834434c11072de8eb8bda7e (diff) | |
Starting work on doxygen cleanup. Many things still to be done.
Diffstat (limited to 'intern')
| -rw-r--r-- | intern/ghost/GHOST_C-api.h | 10 | ||||
| -rw-r--r-- | intern/ghost/GHOST_ISystem.h | 12 | ||||
| -rw-r--r-- | intern/ghost/intern/GHOST_C-api.cpp | 2 |
3 files changed, 12 insertions, 12 deletions
diff --git a/intern/ghost/GHOST_C-api.h b/intern/ghost/GHOST_C-api.h index 5d531ae3f75..20778604a71 100644 --- a/intern/ghost/GHOST_C-api.h +++ b/intern/ghost/GHOST_C-api.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * ***** BEGIN GPL LICENSE BLOCK ***** * @@ -25,10 +25,10 @@ * * ***** END GPL LICENSE BLOCK ***** */ -/** - * @file GHOST_C-api.h +/*! \ingroup GHOST + * + * \file GHOST_C-api.h * GHOST C-API function and type declarations. - * The C-API wraps the C++ objects with the */ #ifndef GHOST_C_API_H @@ -44,7 +44,7 @@ extern "C" { * Creates a "handle" for a C++ GHOST object. * A handle is just an opaque pointer to an empty struct. * In the API the pointer is casted to the actual C++ class. - * @param name Name of the handle to create. + * \param name Name of the handle to create. */ GHOST_DECLARE_HANDLE(GHOST_SystemHandle); diff --git a/intern/ghost/GHOST_ISystem.h b/intern/ghost/GHOST_ISystem.h index ec39248e366..b2b9fff6a4a 100644 --- a/intern/ghost/GHOST_ISystem.h +++ b/intern/ghost/GHOST_ISystem.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * ***** BEGIN GPL LICENSE BLOCK ***** * @@ -25,9 +25,9 @@ * * ***** END GPL LICENSE BLOCK ***** */ -/** - * @file GHOST_ISystem.h - * Main interface file for C++ Api with declaration of GHOST_ISystem interface +/*! \ingroup GHOST + * \file GHOST_ISystem.h + * %Main interface file for C++ Api with declaration of GHOST_ISystem interface * class. * Contains the doxygen documentation main page. */ @@ -42,7 +42,7 @@ class GHOST_IEventConsumer; /** - *! \mainpage GHOST Main Page + * \page GHOST GHOST * * \section intro Introduction * @@ -115,7 +115,7 @@ class GHOST_IEventConsumer; * setting to turn menu functionality on or off. */ -/** +/** \interface GHOST_ISystem * Interface for classes that provide access to the operating system. * There should be only one system class in an application. * Therefore, the routines to create and dispose the system are static. diff --git a/intern/ghost/intern/GHOST_C-api.cpp b/intern/ghost/intern/GHOST_C-api.cpp index 7ac3acdb9b8..5e4faa41f41 100644 --- a/intern/ghost/intern/GHOST_C-api.cpp +++ b/intern/ghost/intern/GHOST_C-api.cpp @@ -1,4 +1,4 @@ -/** +/* * $Id$ * ***** BEGIN GPL LICENSE BLOCK ***** * |