]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/doxygen/overviews/envvars.h
moving forward
[wxWidgets.git] / docs / doxygen / overviews / envvars.h
index 98c9f65acf6d521038210b57b90045ad0399697b..49df4e772cf8c0e7bcadb496545961e62c072f94 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        envvars
+// Name:        envvars.h
 // Purpose:     topic overview
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
@@ -7,69 +7,33 @@
 /////////////////////////////////////////////////////////////////////////////
 
 /*!
- @page envvars_overview Environment variables
+
+ @page overview_envvars Environment variables
+
  This section describes all environment variables that affect execution of
  wxWidgets programs.
- @c WXTRACE
- (Debug build only.)
- This variable can be set to a comma-separated list of trace masks used in
- #wxLogTrace calls;
- wxLog::AddTraceMask is called for every mask
- in the list during wxWidgets initialization.
- @c WXPREFIX
- (Unix only.)
- Overrides installation prefix. Normally, the prefix
- is hard-coded and is the same as the value passed to @c configure via
- the @c --prefix switch when compiling the library (typically
- @c /usr/local or @c /usr). You can set WXPREFIX if you are for example
- distributing a binary version of an application and you don't know in advance
- where it will be installed.
- @c WXMODE
- (wxMGL only.)
- Sets MGL video mode. The value must be in form
- @e widthx@e height-@e depth. The default is @c 640x480-16.
- @c WXSTDERR
- (wxMGL only.)
- Redirects stderr output to a file.
- */
+
+ @beginDefList
+ @itemdef{WXTRACE,
+         (Debug build only.)
+         This variable can be set to a comma-separated list of trace masks used in
+         #wxLogTrace calls; wxLog::AddTraceMask is called for every mask
+         in the list during wxWidgets initialization.}
+ @itemdef{WXPREFIX,
+         (Unix only.)
+         Overrides installation prefix. Normally, the prefix
+         is hard-coded and is the same as the value passed to @c configure via
+         the @c --prefix switch when compiling the library (typically
+         @c /usr/local or @c /usr). You can set WXPREFIX if you are for example
+         distributing a binary version of an application and you don't know in advance
+         where it will be installed.}
+ @itemdef{WXMODE,
+         (wxMGL only.)
+         Sets MGL video mode. The value must be in form
+         @e widthx@e height-@e depth. The default is @c 640x480-16.}
+ @itemdef{WXSTDERR,
+         (wxMGL only.)
+         Redirects stderr output to a file.}
+
+*/
+