Skip to content

Commit

Permalink
Documentation: Further grouping, improved GPL banner
Browse files Browse the repository at this point in the history
  • Loading branch information
skyjake committed Jan 13, 2012
1 parent a019c4d commit bf3dee1
Show file tree
Hide file tree
Showing 8 changed files with 169 additions and 114 deletions.
4 changes: 2 additions & 2 deletions doomsday/doomsday.doxy
Expand Up @@ -63,8 +63,8 @@ SHOW_INCLUDE_FILES = YES
FORCE_LOCAL_INCLUDES = NO
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
SORT_MEMBERS_CTORS_1ST = NO
SORT_BRIEF_DOCS = YES
SORT_MEMBERS_CTORS_1ST = YES
SORT_GROUP_NAMES = YES
SORT_BY_SCOPE_NAME = NO
STRICT_PROTO_MATCHING = NO
Expand Down
32 changes: 14 additions & 18 deletions doomsday/engine/api/dd_api.h
Expand Up @@ -2,26 +2,22 @@
* @file dd_api.h
* Data structures for the engine/plugin interfaces.
*
* @section License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* @authors Copyright &copy; 2003-2012 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright &copy; 2006-2012 Daniel Swanson <danij@dengine.net>
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301 USA
* @par License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* @author Copyright &copy; 2003-2012 Jaakko Keränen <jaakko.keranen@iki.fi>
* @author Copyright &copy; 2006-2012 Daniel Swanson <danij@dengine.net>
* <small>This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. This program is distributed in the hope that it
* will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
* Public License for more details. You should have received a copy of the GNU
* General Public License along with this program; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA</small>
*/

#ifndef LIBDENG_API_H
Expand Down
3 changes: 2 additions & 1 deletion doomsday/engine/api/dd_fontrenderer.h
Expand Up @@ -53,7 +53,8 @@
#define FR_DEF_ATTRIB_CASE_SCALE (false)

/**
* @defGroup drawTextFlags Draw Text Flags
* @defgroup drawTextFlags Draw Text Flags
* @ingroup apiFlags
*/
/*@{*/
#define DTF_NO_TYPEIN (0x0001)
Expand Down
33 changes: 15 additions & 18 deletions doomsday/engine/api/dd_share.h
Expand Up @@ -4,25 +4,22 @@
*
* Various macros and constants used by the engine and games.
*
* @section License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option)
* any later version.
* @authors Copyright &copy; 2003-2012 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright &copy; 2006-2012 Daniel Swanson <danij@dengine.net>
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
* @par License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* @author Copyright &copy; 2003-2012 Jaakko Keränen <jaakko.keranen@iki.fi>
* @author Copyright &copy; 2006-2012 Daniel Swanson <danij@dengine.net>
* <small>This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. This program is distributed in the hope that it
* will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
* Public License for more details. You should have received a copy of the GNU
* General Public License along with this program; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA</small>
*/

#ifndef LIBDENG_SHARED_H
Expand Down Expand Up @@ -1736,7 +1733,7 @@ enum {
};

/**
* @defGroup pspriteFlags PSprite Flags
* @defgroup pspriteFlags PSprite Flags
* @ingroup player apiFlags
*/
///@{
Expand Down
12 changes: 6 additions & 6 deletions doomsday/engine/api/dd_types.h
Expand Up @@ -38,7 +38,7 @@
using wide characters (unicode utf-16le) or ansi for functions and strings.
on Linux and OSX we use utf-8 by default - which conveniently maps to the
CHAR type. As a general guide, any other Win32 T style functions used,
should also be re-implemented here in an ANSI style form for use on Linix,
should also be re-implemented here in an ANSI style form for use on Linux,
OSX, and any other UNIX style operating systems or build environments */
#ifndef WIN32
#define TCHAR CHAR
Expand Down Expand Up @@ -151,8 +151,8 @@ typedef void (*con_textfilter_t) (char* text);
* @ingroup fs
*/
typedef enum {
RC_NULL = -2, /// Not a real class, used internally during resource locator init.
RC_UNKNOWN = -1, /// Attempt to guess the class using heuristic evaluation of the path.
RC_NULL = -2, ///< Not a real class, used internally during resource locator init.
RC_UNKNOWN = -1, ///< Attempt to guess the class using heuristic evaluation of the path.
RESOURCECLASS_FIRST = 0,
RC_PACKAGE = RESOURCECLASS_FIRST,
RC_DEFINITION,
Expand Down Expand Up @@ -198,17 +198,17 @@ typedef unsigned char binangle_t;

#define DDMAXCHAR ((char)0x7f)
#define DDMAXSHORT ((int16_t)0x7fff)
#define DDMAXINT ((int32_t)0x7fffffff) // max pos 32-bit int
#define DDMAXINT ((int32_t)0x7fffffff) ///< Max positive 32-bit int
#define DDMAXLONG ((int32_t)0x7fffffff)
#define DDMAXFLOAT ((float)1E+37)

#define DDMINCHAR ((char)0x80)
#define DDMINSHORT ((int16_t)0x8000)
#define DDMININT ((int32_t)0x80000000) // max negative 32-bit integer
#define DDMININT ((int32_t)0x80000000) ///< Min negative 32-bit integer
#define DDMINLONG ((int32_t)0x80000000)
#define DDMINFLOAT ((float)-(1E+37))

// Predeclarations for map data types. The contents of these structs is
// Forward declarations for map data types. The contents of these structs is
// declared in p_maptypes.h.
struct node_s;
struct vertex_s;
Expand Down

0 comments on commit bf3dee1

Please sign in to comment.