diff options
| -rw-r--r-- | docs/naturaldocs/project/.gitignore | 4 | ||||
| -rw-r--r-- | docs/naturaldocs/project/Languages.txt | 113 | ||||
| -rw-r--r-- | docs/naturaldocs/project/Menu.txt | 104 | ||||
| -rw-r--r-- | docs/naturaldocs/project/Topics.txt | 81 | ||||
| -rw-r--r-- | src/gd_bmp.c | 7 | ||||
| -rw-r--r-- | src/gd_gd.c | 10 | ||||
| -rw-r--r-- | src/gd_gd2.c | 10 | ||||
| -rw-r--r-- | src/gd_gif_in.c | 6 | ||||
| -rw-r--r-- | src/gd_gif_out.c | 6 | ||||
| -rw-r--r-- | src/gd_jpeg.c | 5 | ||||
| -rw-r--r-- | src/gd_png.c | 6 | ||||
| -rw-r--r-- | src/gd_tga.c | 6 | ||||
| -rw-r--r-- | src/gd_tiff.c | 9 | ||||
| -rw-r--r-- | src/gd_wbmp.c | 6 | ||||
| -rw-r--r-- | src/gd_webp.c | 6 | ||||
| -rw-r--r-- | src/gd_xbm.c | 6 | ||||
| -rw-r--r-- | src/gdxpm.c | 8 |
17 files changed, 197 insertions, 196 deletions
diff --git a/docs/naturaldocs/project/.gitignore b/docs/naturaldocs/project/.gitignore index a8608a2..b2a9740 100644 --- a/docs/naturaldocs/project/.gitignore +++ b/docs/naturaldocs/project/.gitignore @@ -1,2 +1,2 @@ -# This is dynamically generated based on the version & source files. -/Menu.txt +Languages.txt +Topics.txt diff --git a/docs/naturaldocs/project/Languages.txt b/docs/naturaldocs/project/Languages.txt deleted file mode 100644 index 85d5fde..0000000 --- a/docs/naturaldocs/project/Languages.txt +++ /dev/null @@ -1,113 +0,0 @@ -Format: 1.51 - -# This is the Natural Docs languages file for this project. If you change -# anything here, it will apply to THIS PROJECT ONLY. If you'd like to change -# something for all your projects, edit the Languages.txt in Natural Docs' -# Config directory instead. - - -# You can prevent certain file extensions from being scanned like this: -# Ignore Extensions: [extension] [extension] ... - - -#------------------------------------------------------------------------------- -# SYNTAX: -# -# Unlike other Natural Docs configuration files, in this file all comments -# MUST be alone on a line. Some languages deal with the # character, so you -# cannot put comments on the same line as content. -# -# Also, all lists are separated with spaces, not commas, again because some -# languages may need to use them. -# -# Language: [name] -# Alter Language: [name] -# Defines a new language or alters an existing one. Its name can use any -# characters. If any of the properties below have an add/replace form, you -# must use that when using Alter Language. -# -# The language Shebang Script is special. It's entry is only used for -# extensions, and files with those extensions have their shebang (#!) lines -# read to determine the real language of the file. Extensionless files are -# always treated this way. -# -# The language Text File is also special. It's treated as one big comment -# so you can put Natural Docs content in them without special symbols. Also, -# if you don't specify a package separator, ignored prefixes, or enum value -# behavior, it will copy those settings from the language that is used most -# in the source tree. -# -# Extensions: [extension] [extension] ... -# [Add/Replace] Extensions: [extension] [extension] ... -# Defines the file extensions of the language's source files. You can -# redefine extensions found in the main languages file. You can use * to -# mean any undefined extension. -# -# Shebang Strings: [string] [string] ... -# [Add/Replace] Shebang Strings: [string] [string] ... -# Defines a list of strings that can appear in the shebang (#!) line to -# designate that it's part of the language. You can redefine strings found -# in the main languages file. -# -# Ignore Prefixes in Index: [prefix] [prefix] ... -# [Add/Replace] Ignored Prefixes in Index: [prefix] [prefix] ... -# -# Ignore [Topic Type] Prefixes in Index: [prefix] [prefix] ... -# [Add/Replace] Ignored [Topic Type] Prefixes in Index: [prefix] [prefix] ... -# Specifies prefixes that should be ignored when sorting symbols in an -# index. Can be specified in general or for a specific topic type. -# -#------------------------------------------------------------------------------ -# For basic language support only: -# -# Line Comments: [symbol] [symbol] ... -# Defines a space-separated list of symbols that are used for line comments, -# if any. -# -# Block Comments: [opening sym] [closing sym] [opening sym] [closing sym] ... -# Defines a space-separated list of symbol pairs that are used for block -# comments, if any. -# -# Package Separator: [symbol] -# Defines the default package separator symbol. The default is a dot. -# -# [Topic Type] Prototype Enders: [symbol] [symbol] ... -# When defined, Natural Docs will attempt to get a prototype from the code -# immediately following the topic type. It stops when it reaches one of -# these symbols. Use \n for line breaks. -# -# Line Extender: [symbol] -# Defines the symbol that allows a prototype to span multiple lines if -# normally a line break would end it. -# -# Enum Values: [global|under type|under parent] -# Defines how enum values are referenced. The default is global. -# global - Values are always global, referenced as 'value'. -# under type - Values are under the enum type, referenced as -# 'package.enum.value'. -# under parent - Values are under the enum's parent, referenced as -# 'package.value'. -# -# Perl Package: [perl package] -# Specifies the Perl package used to fine-tune the language behavior in ways -# too complex to do in this file. -# -#------------------------------------------------------------------------------ -# For full language support only: -# -# Full Language Support: [perl package] -# Specifies the Perl package that has the parsing routines necessary for full -# language support. -# -#------------------------------------------------------------------------------- - -# The following languages are defined in the main file, if you'd like to alter -# them: -# -# Text File, Shebang Script, C/C++, C#, Java, JavaScript, Perl, Python, -# PHP, SQL, Visual Basic, Pascal, Assembly, Ada, Tcl, Ruby, Makefile, -# ActionScript, ColdFusion, R, Fortran - -# If you add a language that you think would be useful to other developers -# and should be included in Natural Docs by default, please e-mail it to -# languages [at] naturaldocs [dot] org. diff --git a/docs/naturaldocs/project/Menu.txt b/docs/naturaldocs/project/Menu.txt new file mode 100644 index 0000000..d4e9f41 --- /dev/null +++ b/docs/naturaldocs/project/Menu.txt @@ -0,0 +1,104 @@ +Format: 1.52 + + +# You can add a title and sub-title to your menu like this: +# Title: [project name] +# SubTitle: [subtitle] + +# You can add a footer to your documentation like this: +# Footer: [text] +# If you want to add a copyright notice, this would be the place to do it. + +# You can add a timestamp to your documentation like one of these: +# Timestamp: Generated on month day, year +# Timestamp: Updated mm/dd/yyyy +# Timestamp: Last updated mon day +# +# m - One or two digit month. January is "1" +# mm - Always two digit month. January is "01" +# mon - Short month word. January is "Jan" +# month - Long month word. January is "January" +# d - One or two digit day. 1 is "1" +# dd - Always two digit day. 1 is "01" +# day - Day with letter extension. 1 is "1st" +# yy - Two digit year. 2006 is "06" +# yyyy - Four digit year. 2006 is "2006" +# year - Four digit year. 2006 is "2006" + + +# -------------------------------------------------------------------------- +# +# Cut and paste the lines below to change the order in which your files +# appear on the menu. Don't worry about adding or removing files, Natural +# Docs will take care of that. +# +# You can further organize the menu by grouping the entries. Add a +# "Group: [name] {" line to start a group, and add a "}" to end it. +# +# You can add text and web links to the menu by adding "Text: [text]" and +# "Link: [name] ([URL])" lines, respectively. +# +# The formatting and comments are auto-generated, so don't worry about +# neatness when editing the file. Natural Docs will clean it up the next +# time it is run. When working with groups, just deal with the braces and +# forget about the indentation and comments. +# +# -------------------------------------------------------------------------- + + +File: About LibGD 2.3.0-dev (preamble.txt) + +Group: Image Formats { + + File: BMP IO (gd_bmp.c) + File: GD IO (gd_gd.c) + File: GD2 IO (gd_gd2.c) + File: GIF Input (gd_gif_in.c) + File: GIF Output (gd_gif_out.c) + File: JPEG IO (gd_jpeg.c) + File: PNG IO (gd_png.c) + File: TGA Input (gd_tga.c) + File: TIFF IO (gd_tiff.c) + File: WBMP IO (gd_wbmp.c) + File: WebP IO (gd_webp.c) + File: XBM IO (gd_xbm.c) + File: XPM Input (gdxpm.c) + } # Group: Image Formats + +File: gd.c (gd.c) +File: gd.h (gd.h) +File: gd_crop.c (gd_crop.c) +File: gd_filename.c (gd_filename.c) +File: gd_filter.c (gd_filter.c) +File: gd_interpolation.c (gd_interpolation.c) +File: gd_io.h (gd_io.h) +File: gd_io_dp.c (gd_io_dp.c) +File: gd_ss.c (gd_ss.c) +File: gd_topal.c (gd_topal.c) +File: gd_transform.c (gd_transform.c) +File: gd_version.c (gd_version.c) +File: gdColorMapLookup (gd_color_map.c) +File: gdFontGetGiant (gdfontg.c) +File: gdFontGetLarge (gdfontl.c) +File: gdFontGetMediumBold (gdfontmb.c) +File: gdFontGetSmall (gdfonts.c) +File: gdFontGetTiny (gdfontt.c) +File: gdFree (gdhelpers.c) +File: gdft.c (gdft.c) +File: gdfx.c (gdfx.c) +File: gdImageColorMatch (gd_color_match.c) +File: gdImageNeuQuant (gd_nnquant.c) +File: gdNewFileCtx (gd_io_file.c) +File: gdNewSSCtx (gd_io_ss.c) +File: License (license.txt) +File: Matrix (gd_matrix.c) + +Group: Index { + + Constant Index: Constants + Index: Everything + File Index: Files + Function Index: Functions + Type Index: Types + } # Group: Index + diff --git a/docs/naturaldocs/project/Topics.txt b/docs/naturaldocs/project/Topics.txt deleted file mode 100644 index 2153090..0000000 --- a/docs/naturaldocs/project/Topics.txt +++ /dev/null @@ -1,81 +0,0 @@ -Format: 1.51 - -# This is the Natural Docs topics file for this project. If you change anything -# here, it will apply to THIS PROJECT ONLY. If you'd like to change something -# for all your projects, edit the Topics.txt in Natural Docs' Config directory -# instead. - - -# If you'd like to prevent keywords from being recognized by Natural Docs, you -# can do it like this: -# Ignore Keywords: [keyword], [keyword], ... -# -# Or you can use the list syntax like how they are defined: -# Ignore Keywords: -# [keyword] -# [keyword], [plural keyword] -# ... - - -#------------------------------------------------------------------------------- -# SYNTAX: -# -# Topic Type: [name] -# Alter Topic Type: [name] -# Creates a new topic type or alters one from the main file. Each type gets -# its own index and behavior settings. Its name can have letters, numbers, -# spaces, and these charaters: - / . ' -# -# Plural: [name] -# Sets the plural name of the topic type, if different. -# -# Keywords: -# [keyword] -# [keyword], [plural keyword] -# ... -# Defines or adds to the list of keywords for the topic type. They may only -# contain letters, numbers, and spaces and are not case sensitive. Plural -# keywords are used for list topics. You can redefine keywords found in the -# main topics file. -# -# Index: [yes|no] -# Whether the topics get their own index. Defaults to yes. Everything is -# included in the general index regardless of this setting. -# -# Scope: [normal|start|end|always global] -# How the topics affects scope. Defaults to normal. -# normal - Topics stay within the current scope. -# start - Topics start a new scope for all the topics beneath it, -# like class topics. -# end - Topics reset the scope back to global for all the topics -# beneath it. -# always global - Topics are defined as global, but do not change the scope -# for any other topics. -# -# Class Hierarchy: [yes|no] -# Whether the topics are part of the class hierarchy. Defaults to no. -# -# Page Title If First: [yes|no] -# Whether the topic's title becomes the page title if it's the first one in -# a file. Defaults to no. -# -# Break Lists: [yes|no] -# Whether list topics should be broken into individual topics in the output. -# Defaults to no. -# -# Can Group With: [type], [type], ... -# Defines a list of topic types that this one can possibly be grouped with. -# Defaults to none. -#------------------------------------------------------------------------------- - -# The following topics are defined in the main file, if you'd like to alter -# their behavior or add keywords: -# -# Generic, Class, Interface, Section, File, Group, Function, Variable, -# Property, Type, Constant, Enumeration, Event, Delegate, Macro, -# Database, Database Table, Database View, Database Index, Database -# Cursor, Database Trigger, Cookie, Build Target - -# If you add something that you think would be useful to other developers -# and should be included in Natural Docs by default, please e-mail it to -# topics [at] naturaldocs [dot] org. diff --git a/src/gd_bmp.c b/src/gd_bmp.c index 2170715..1eb2ebe 100644 --- a/src/gd_bmp.c +++ b/src/gd_bmp.c @@ -12,6 +12,13 @@ ---------------------------------------------------------------------------- */ + +/** + * File: BMP IO + * + * Read and write BMP images. + */ + /* $Id$ */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/src/gd_gd.c b/src/gd_gd.c index 13defa0..55f500a 100644 --- a/src/gd_gd.c +++ b/src/gd_gd.c @@ -1,3 +1,13 @@ +/** + * File: GD IO + * + * Read and write GD images. + * + * The GD image format is a proprietary image format of libgd. It has to be + * regarded as being obsolete, and should only be used for development and + * testing purposes. + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/src/gd_gd2.c b/src/gd_gd2.c index bdc9bf5..542e507 100644 --- a/src/gd_gd2.c +++ b/src/gd_gd2.c @@ -10,6 +10,16 @@ * */ +/** + * File: GD2 IO + * + * Read and write GD2 images. + * + * The GD2 image format is a proprietary image format of libgd. It has to be + * regarded as being obsolete, and should only be used for development and + * testing purposes. + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/src/gd_gif_in.c b/src/gd_gif_in.c index 3ae74de..9832da8 100644 --- a/src/gd_gif_in.c +++ b/src/gd_gif_in.c @@ -1,3 +1,9 @@ +/** + * File: GIF Input + * + * Read GIF images. + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/src/gd_gif_out.c b/src/gd_gif_out.c index 3099d49..c35db28 100644 --- a/src/gd_gif_out.c +++ b/src/gd_gif_out.c @@ -1,3 +1,9 @@ +/** + * File: GIF Output + * + * Write GIF images. + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/src/gd_jpeg.c b/src/gd_jpeg.c index 5123395..0b0a102 100644 --- a/src/gd_jpeg.c +++ b/src/gd_jpeg.c @@ -21,6 +21,11 @@ * Christian Aberger */ +/** + * File: JPEG IO + * + * Read and write JPEG images. + */ #ifdef HAVE_CONFIG_H # include "config.h" diff --git a/src/gd_png.c b/src/gd_png.c index ab93e43..9c5e83b 100644 --- a/src/gd_png.c +++ b/src/gd_png.c @@ -42,6 +42,12 @@ ---------------------------------------------------------------------------*/ +/** + * File: PNG IO + * + * Read and write PNG images. + */ + #ifdef PNG_SETJMP_SUPPORTED typedef struct _jmpbuf_wrapper { jmp_buf jmpbuf; diff --git a/src/gd_tga.c b/src/gd_tga.c index 1705324..ec6781f 100644 --- a/src/gd_tga.c +++ b/src/gd_tga.c @@ -1,3 +1,9 @@ +/** + * File: TGA Input + * + * Read TGA images. + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif /* HAVE_CONFIG_H */ diff --git a/src/gd_tiff.c b/src/gd_tiff.c index 26805ff..b4f1e63 100644 --- a/src/gd_tiff.c +++ b/src/gd_tiff.c @@ -29,6 +29,15 @@ */ /* $Id$ */ +/** + * File: TIFF IO + * + * Read and write TIFF images. + * + * There is only most basic support for the TIFF format available for now; + * for instance, multiple pages are not yet supported. + */ + #ifdef HAVE_CONFIG_H # include "config.h" #endif diff --git a/src/gd_wbmp.c b/src/gd_wbmp.c index d9de591..b54c046 100644 --- a/src/gd_wbmp.c +++ b/src/gd_wbmp.c @@ -51,6 +51,12 @@ *-------------------------------------------------------------------------- */ +/** + * File: WBMP IO + * + * Read and write WBMP images. + */ + #ifdef HAVE_CONFIG_H # include "config.h" #endif diff --git a/src/gd_webp.c b/src/gd_webp.c index 622d379..8eb4dee 100644 --- a/src/gd_webp.c +++ b/src/gd_webp.c @@ -1,3 +1,9 @@ +/** + * File: WebP IO + * + * Read and write WebP images. + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif /* HAVE_CONFIG_H */ diff --git a/src/gd_xbm.c b/src/gd_xbm.c index 58b5720..9d25290 100644 --- a/src/gd_xbm.c +++ b/src/gd_xbm.c @@ -1,3 +1,9 @@ +/** + * File: XBM IO + * + * Read and write XBM images. + */ + #ifdef HAVE_CONFIG_H # include "config.h" #endif diff --git a/src/gdxpm.c b/src/gdxpm.c index 15603a6..3ee4877 100644 --- a/src/gdxpm.c +++ b/src/gdxpm.c @@ -5,6 +5,14 @@ * http://www.csn.ul.ie/~caolan */ + +/** + * File: XPM Input + * + * Read XPM images. + */ + + #ifdef HAVE_CONFIG_H # include "config.h" #endif |