From 97ff10fadc3586ca560971430d8be277a2e40fcc Mon Sep 17 00:00:00 2001 From: Crayon2000 Date: Mon, 23 Nov 2009 23:38:46 +0000 Subject: [PATCH] [CHG] The template example is now included in the documentation --- GRRLIB/GRRLIB/grrlib.h | 7 ++++++- grrlib.doxygen | 36 ++++-------------------------------- 2 files changed, 10 insertions(+), 33 deletions(-) diff --git a/GRRLIB/GRRLIB/grrlib.h b/GRRLIB/GRRLIB/grrlib.h index d3319a5..587c604 100644 --- a/GRRLIB/GRRLIB/grrlib.h +++ b/GRRLIB/GRRLIB/grrlib.h @@ -268,4 +268,9 @@ GRR_EXTERN u32 fb GRR_INIT(0); * 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. - */ + * + * @example template/main.c + * This example shows the minimum code required to use GRRLIB. + * It could be used as a template to start a new project. + * More elaborate examples can be found inside the \e examples folder. + */ \ No newline at end of file diff --git a/grrlib.doxygen b/grrlib.doxygen index 4fa9208..ec721d5 100644 --- a/grrlib.doxygen +++ b/grrlib.doxygen @@ -603,36 +603,8 @@ INPUT_ENCODING = UTF-8 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ *.cpp \ - *.c++ \ - *.d \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.idl \ - *.odl \ - *.cs \ - *.php \ - *.php3 \ - *.inc \ - *.m \ - *.mm \ - *.dox \ - *.py \ - *.f90 \ - *.f \ - *.vhd \ - *.vhdl + *.h # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. @@ -672,21 +644,21 @@ EXCLUDE_SYMBOLS = # directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = +EXAMPLE_PATH = ./examples # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank all files are included. -EXAMPLE_PATTERNS = * +EXAMPLE_PATTERNS = *.c # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude # commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. -EXAMPLE_RECURSIVE = NO +EXAMPLE_RECURSIVE = YES # The IMAGE_PATH tag can be used to specify one or more files or # directories that contain image that are included in the documentation (see