X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/15b6757b26a0277472a4f6b071b52050abd922da..0d14e4f21d2aa9e7edf0cf08a352743619f41e0b:/docs/doxygen/overviews/envvars.h diff --git a/docs/doxygen/overviews/envvars.h b/docs/doxygen/overviews/envvars.h index 98c9f65acf..f997db35e5 100644 --- a/docs/doxygen/overviews/envvars.h +++ b/docs/doxygen/overviews/envvars.h @@ -1,75 +1,39 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: envvars +// Name: envvars.h // Purpose: topic overview // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// -/*! - - @page envvars_overview 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. - - */ - - +/** + +@page overview_envvars Environment Variables + +This section describes all environment variables that affect execution of +wxWidgets programs. + +@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.} + +*/ +