mirror of
https://github.com/GRRLIB/GRRLIB.git
synced 2024-11-22 06:52:20 +00:00
[CHG] Now using doxygen 1.6.0 with search enabled (file description are still missing)
This commit is contained in:
parent
c493224a34
commit
96a383a4b1
12 changed files with 114 additions and 34 deletions
|
@ -20,16 +20,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
THE SOFTWARE.
|
THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
/*------------------------------------------------------------------------------
|
|
||||||
Library : GRRLIB (GX inside)
|
|
||||||
Version : 4.1.0
|
|
||||||
Project Leader : NoNameNo
|
|
||||||
Documentation : Crayon, BlueChip
|
|
||||||
Lead Coder : NoNameNo,
|
|
||||||
Support Coders : Crayon, Xane, DragonMinded, BlueChip
|
|
||||||
Advisors : RedShade, JESPA
|
|
||||||
------------------------------------------------------------------------------*/
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file GRRLIB.h
|
* @file GRRLIB.h
|
||||||
* GRRLIB library.
|
* GRRLIB library.
|
||||||
|
@ -237,4 +227,36 @@ GRR_EXTERN u32 fb GRR_INIT(0) ;
|
||||||
* @mainpage GRRLIB Documentation
|
* @mainpage GRRLIB Documentation
|
||||||
* @image html grrlib_logo.png
|
* @image html grrlib_logo.png
|
||||||
* Welcome to the GRRLIB documentation.
|
* Welcome to the GRRLIB documentation.
|
||||||
|
*
|
||||||
|
* @section Introduction
|
||||||
|
* GRRLIB is a C/C++ 2D Graphics library for Wii application developers.
|
||||||
|
* It is essentially a wrapper which presents a friendly interface to the Nintendo GX core.
|
||||||
|
*
|
||||||
|
* @section Credits
|
||||||
|
* Project Leader : NoNameNo\n
|
||||||
|
* Documentation : Crayon, BlueChip\n
|
||||||
|
* Lead Coder : NoNameNo\n
|
||||||
|
* Support Coders : Crayon, Xane, DragonMinded, BlueChip\n
|
||||||
|
* Advisors : RedShade, JESPA\n
|
||||||
|
*
|
||||||
|
* @section Licence
|
||||||
|
* Copyright (c) 2009 The GRRLIB Team
|
||||||
|
*
|
||||||
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
* of this software and associated documentation files (the "Software"), to deal
|
||||||
|
* in the Software without restriction, including without limitation the rights
|
||||||
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
* copies of the Software, and to permit persons to whom the Software is
|
||||||
|
* furnished to do so, subject to the following conditions:
|
||||||
|
*
|
||||||
|
* The above copyright notice and this permission notice shall be included in
|
||||||
|
* all copies or substantial portions of the Software.
|
||||||
|
*
|
||||||
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR 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.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -20,6 +20,11 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
THE SOFTWARE.
|
THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file GRRLIB_cExtn.h
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
#include <math.h>
|
#include <math.h>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -20,6 +20,11 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
THE SOFTWARE.
|
THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file GRRLIB_clipping.h
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Reset the clipping to normal.
|
* Reset the clipping to normal.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -20,6 +20,11 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
THE SOFTWARE.
|
THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file GRRLIB_collision.h
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Determine whether the specified point lies within the specified rectangle.
|
* Determine whether the specified point lies within the specified rectangle.
|
||||||
* @param hotx Specifies the x-coordinate of the upper-left corner of the rectangle.
|
* @param hotx Specifies the x-coordinate of the upper-left corner of the rectangle.
|
||||||
|
|
|
@ -20,6 +20,11 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
THE SOFTWARE.
|
THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file GRRLIB_fbComplex.h
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Draw an array of points.
|
* Draw an array of points.
|
||||||
* @param v Array containing the points.
|
* @param v Array containing the points.
|
||||||
|
|
|
@ -20,6 +20,11 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
THE SOFTWARE.
|
THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file GRRLIB_fbGX.h
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Draws a vector.
|
* Draws a vector.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -20,6 +20,11 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
THE SOFTWARE.
|
THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file GRRLIB_fbSimple.h
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
#include <math.h>
|
#include <math.h>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -20,6 +20,11 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
THE SOFTWARE.
|
THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file GRRLIB_handle.h
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set a texture's X and Y handles. e.g. for rotation.
|
* Set a texture's X and Y handles. e.g. for rotation.
|
||||||
* @param tex The texture to set the handle on.
|
* @param tex The texture to set the handle on.
|
||||||
|
|
|
@ -20,6 +20,11 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
THE SOFTWARE.
|
THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file GRRLIB_pixel.h
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the color value of a pixel from a GRRLIB_texImg.
|
* Return the color value of a pixel from a GRRLIB_texImg.
|
||||||
* @param x Specifies the x-coordinate of the pixel in the texture.
|
* @param x Specifies the x-coordinate of the pixel in the texture.
|
||||||
|
|
|
@ -20,6 +20,11 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
THE SOFTWARE.
|
THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file GRRLIB_settings.h
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
#include <math.h>
|
#include <math.h>
|
||||||
|
|
||||||
#include "GRRLIB.h"
|
#include "GRRLIB.h"
|
||||||
|
|
|
@ -20,6 +20,11 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
THE SOFTWARE.
|
THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file GRRLIB_texSetup.h
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
#include <malloc.h>
|
#include <malloc.h>
|
||||||
#include <pngu.h>
|
#include <pngu.h>
|
||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Doxyfile 1.5.9
|
# Doxyfile 1.6.0
|
||||||
|
|
||||||
# This file describes the settings to be used by the documentation system
|
# This file describes the settings to be used by the documentation system
|
||||||
# doxygen (www.doxygen.org) for a project
|
# doxygen (www.doxygen.org) for a project
|
||||||
|
@ -416,6 +416,16 @@ SORT_MEMBER_DOCS = YES
|
||||||
|
|
||||||
SORT_BRIEF_DOCS = NO
|
SORT_BRIEF_DOCS = NO
|
||||||
|
|
||||||
|
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
|
||||||
|
# will sort the (brief and detailed) documentation of class members so that
|
||||||
|
# constructors and destructors are listed first. If set to NO (the default)
|
||||||
|
# the constructors will appear in the respective orders defined by
|
||||||
|
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
|
||||||
|
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
|
||||||
|
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
|
||||||
|
|
||||||
|
SORT_MEMBERS_CTORS_1ST = NO
|
||||||
|
|
||||||
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
|
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
|
||||||
# hierarchy of group names into alphabetical order. If set to NO (the default)
|
# hierarchy of group names into alphabetical order. If set to NO (the default)
|
||||||
# the group names will appear in their defined order.
|
# the group names will appear in their defined order.
|
||||||
|
@ -972,17 +982,15 @@ ENUM_VALUES_PER_LINE = 4
|
||||||
# If the tag value is set to FRAME, a side panel will be generated
|
# If the tag value is set to FRAME, a side panel will be generated
|
||||||
# containing a tree-like index structure (just like the one that
|
# containing a tree-like index structure (just like the one that
|
||||||
# is generated for HTML Help). For this to work a browser that supports
|
# is generated for HTML Help). For this to work a browser that supports
|
||||||
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
|
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
|
||||||
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
|
# Windows users are probably better off using the HTML help feature.
|
||||||
# probably better off using the HTML help feature. Other possible values
|
|
||||||
# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
|
|
||||||
# and Class Hierarchy pages using a tree view instead of an ordered list;
|
|
||||||
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
|
|
||||||
# disables this behavior completely. For backwards compatibility with previous
|
|
||||||
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
|
|
||||||
# respectively.
|
|
||||||
|
|
||||||
GENERATE_TREEVIEW = NONE
|
GENERATE_TREEVIEW = NO
|
||||||
|
|
||||||
|
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
|
||||||
|
# and Class Hierarchy pages using a tree view instead of an ordered list.
|
||||||
|
|
||||||
|
USE_INLINE_TREES = NO
|
||||||
|
|
||||||
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
|
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
|
||||||
# used to set the initial width (in pixels) of the frame in which the tree
|
# used to set the initial width (in pixels) of the frame in which the tree
|
||||||
|
@ -998,6 +1006,15 @@ TREEVIEW_WIDTH = 250
|
||||||
|
|
||||||
FORMULA_FONTSIZE = 10
|
FORMULA_FONTSIZE = 10
|
||||||
|
|
||||||
|
# When the SEARCHENGINE tag is enable doxygen will generate a search box
|
||||||
|
# for the HTML output. The underlying search engine uses javascript
|
||||||
|
# and DHTML and should work on any modern browser. Note that when using
|
||||||
|
# HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
|
||||||
|
# there is already a search function so this one should typically
|
||||||
|
# be disabled.
|
||||||
|
|
||||||
|
SEARCHENGINE = YES
|
||||||
|
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
# configuration options related to the LaTeX output
|
# configuration options related to the LaTeX output
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
|
@ -1479,7 +1496,7 @@ DOT_IMAGE_FORMAT = png
|
||||||
# The tag DOT_PATH can be used to specify the path where the dot tool can be
|
# The tag DOT_PATH can be used to specify the path where the dot tool can be
|
||||||
# found. If left blank, it is assumed the dot tool can be found in the path.
|
# found. If left blank, it is assumed the dot tool can be found in the path.
|
||||||
|
|
||||||
DOT_PATH = "C:\Program Files\Graphviz\bin"
|
DOT_PATH = D:\Programmes\Graphviz\bin
|
||||||
|
|
||||||
# The DOTFILE_DIRS tag can be used to specify one or more directories that
|
# The DOTFILE_DIRS tag can be used to specify one or more directories that
|
||||||
# contain dot files that are included in the documentation (see the
|
# contain dot files that are included in the documentation (see the
|
||||||
|
@ -1533,12 +1550,3 @@ GENERATE_LEGEND = NO
|
||||||
# the various graphs.
|
# the various graphs.
|
||||||
|
|
||||||
DOT_CLEANUP = YES
|
DOT_CLEANUP = YES
|
||||||
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# Options related to the search engine
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
# The SEARCHENGINE tag specifies whether or not a search engine should be
|
|
||||||
# used. If set to NO the values of all tags below this one will be ignored.
|
|
||||||
|
|
||||||
SEARCHENGINE = NO
|
|
||||||
|
|
Loading…
Reference in a new issue