cheng/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix part of the doxygen warnings introducing aliases for preprocessor commands; replacing some \_ with _ and fixing links to the libraries_page

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@51920 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi 2008-02-19 16:51:34 +00:00
parent d513b59d1a
commit a346529478
10 changed files with 30 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/doxygen/Doxyfile
View File

@ -71,8 +71,19 @@ ALIASES += true="\b true"
ALIASES += false="\b false"
ALIASES += NULL="\b NULL"
# these are useful for creation of tables
ALIASES += row{2}=""
# NOTE: we could put aliases also for e.g. @wxDefaultSize, @wxDefaultPosition, @wxID_ANY, etc
# NOTE: these are important as you can't write in the docs
# just #ifdef since the # character is used by Doxygen
# for explicit linking; use the following aliases instead!
ALIASES += ifdef="\b \c \#ifdef"
ALIASES += ifndef="\b \c \#ifndef"
ALIASES += if="\b \c \#if" # NOTE: this overrides the Doxygen \if command
ALIASES += endif="\b \c \#endif"
#---------------------------------------------------------------------------
# Build related configuration options
@ -119,7 +130,7 @@ WARN_LOGFILE = doxygen.log
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = . ./overviews ../../include/interface
INPUT = . ./overviews ../../interface
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.h *.txt
RECURSIVE = YES
@ -213,7 +224,7 @@ MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = YES
GENERATE_XML = NO
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =

4
docs/doxygen/categories.h
View File

@ -194,7 +194,7 @@
This is a new set of classes for writing a customizable application
interface with built-in docking, floatable panes and a flexible
MDI-like interface. Further classes for custom notebooks with
draggable tabs etc. are in progress. See also @ref wxaui_overview.
draggable tabs etc. are in progress. See also @ref aui_overview.
@li wxAuiManager: The central class for managing the interface
@li wxAuiNotebook: A replacement notebook class with extra features
@ -443,7 +443,7 @@
@li wxDebugContext: Provides memory-checking facilities
@li Debugging macros: Debug macros for assertion and checking
@li WXDEBUG\_NEW: Use this macro to give further debugging information
@li WXDEBUG_NEW: Use this macro to give further debugging information
@li wxDebugReport: Base class for creating debug reports in case of a program crash.
@li wxDebugReportCompress: Class for creating compressed debug reports.
@li wxDebugReportUpload: Class for uploading compressed debug reports via HTTP.

6
docs/doxygen/const_cpp.h
View File

@ -15,7 +15,7 @@
by category (and sorted by alphabetical order inside each category).
All of these macros except for the @c wxUSE_XXX variety is defined if the
corresponding condition is @true and undefined if it isn't, so they should be
always tested using @c #ifdef and not @c #if.
always tested using @ifdef and not @if.
TODO: what can we use here instead of \twocolitem to keep text readable??
@ -155,7 +155,7 @@
macro corresponds to the compiler version: $1020$ for $4.2$ (the first supported
version), $1100$ for $5.0$, $1200$ for $6.0$ and so on. For convenience, the
symbols __VISUALCn__ are also defined for each major compiler version from
5 to 9, i.e. you can use tests such @c #ifdef __VISUALC7__} to test
5 to 9, i.e. you can use tests such @ifdef __VISUALC7__} to test
for compiler version being precisely 7.}
\twocolitem{__XLC__}{AIX compiler}
\twocolitem{__WATCOMC__}{Watcom C++. The value of this macro corresponds to
@ -204,7 +204,7 @@
includes a number of wxWidgets headers thus making it unnecessary to include
them explicitly. However if this is not defined, you do need to include them
and so the usual idiom which allows to support both cases is to first include
@c wx/wxprec.h} and then, inside @c #ifndef WX_PRECOMP}, individual
@c wx/wxprec.h} and then, inside @ifndef WX_PRECOMP}, individual
headers you need.}
\twocolitem{_UNICODE and UNICODE}{both are defined if wxUSE_UNICODE is set to $1$}
\twocolitem{wxUSE_GUI}{this particular feature test macro is defined to $1$

2
docs/doxygen/const_keymod.h
View File

@ -33,7 +33,7 @@
};
@endverbatim
Notice that @c wxMOD\_CMD should be used instead of @c wxMOD_CONTROL
Notice that @c wxMOD_CMD should be used instead of @c wxMOD_CONTROL
in portable code to account for the fact that although
@c Control modifier exists under Mac OS, it is not used for the same
purpose as under Windows or Unix there while the special Mac-specific

2
docs/doxygen/const_wxusedef.h
View File

@ -16,7 +16,7 @@
category). These symbols are always defined and whether the given feature is
active or not depends on their value: if defined as @c 1, feature is active,
otherwise it is disabled. Because of this these symbols should be always tested
using @c #if and not @c #ifdef.
using @if and not @ifdef.
@li @ref wxusedefmulti
@li @ref wxusedefunix

4
docs/doxygen/copyright.h
View File

@ -110,7 +110,7 @@
[This is the first released version of the library GPL. It is
numbered 2 because it goes with version 2 of the ordinary GPL.]
@subsection Preamble
@section gnulicense_preamble Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
@ -545,7 +545,7 @@
END OF TERMS AND CONDITIONS
</center>
@subsection Appendix: How to Apply These Terms to Your New Libraries
@section gnulicense_appendix Appendix: How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that

6
docs/doxygen/devtips.h
View File

@ -69,7 +69,7 @@
Most ports of wxWidgets can create either a static library or a shared
library. wxWidgets can also be built in multilib and monolithic variants.
See the @ref librarieslist for more information on these.
See the @ref libraries_page for more information on these.
@ -198,8 +198,8 @@
wxInt32, wxInt16, wxInt8, wxUint32, wxUint16 = wxWord, wxUint8 = wxByte
where wxInt32 stands for a 32-bit signed integer type etc. You can also check
which architecture the program is compiled on using the wxBYTE\_ORDER define
which is either wxBIG\_ENDIAN or wxLITTLE\_ENDIAN (in the future maybe wxPDP\_ENDIAN
which architecture the program is compiled on using the wxBYTE_ORDER define
which is either wxBIG_ENDIAN or wxLITTLE_ENDIAN (in the future maybe wxPDP_ENDIAN
as well).
The macros handling bit-swapping with respect to the applications endianness

6
docs/doxygen/platdetails.h
View File

@ -506,13 +506,13 @@
doesn't do a perfect job of converting the project files from eVC++ format.
When you have converted the wxWidgets workspace, edit the configuration properties
for each configuration and in the Librarian, add a relative path ..\..\lib to
for each configuration and in the Librarian, add a relative path ..\\..\\lib to
each library path. For example:
<tt>..\$(PlatformName)\$(ConfigurationName)\wx_mono.lib</tt>.
<tt>..\\$(PlatformName)\\$(ConfigurationName)\\wx_mono.lib</tt>.
Then, for a sample you want to compile, edit the configuration properties
and make sure
<tt>..\..\lib\\$(PlatformName)\\$(ConfigurationName)</tt>
<tt>..\\..\\lib\\$(PlatformName)\\$(ConfigurationName)</tt>
is in the Linker/General/Additional Library Directories property.
Also change the Linker/Input/Additional Dependencies property to something like
<tt>coredll.lib wx_mono.lib wx_wxjpeg.lib wx_wxpng.lib wx_wxzlib.lib wx_wxexpat.lib

2
docs/doxygen/utilities.h
View File

@ -10,7 +10,7 @@
@page utilities_page Utilities and libraries supplied with wxWidgets
In addition to the @ref librarieslist, some
In addition to the @ref libraries_page, some
additional utilities are supplied in the @c utils hierarchy.
For other user-contributed packages, please see the Contributions page

1
docs/doxygen/wxwidgets.css
View File

@ -11,6 +11,7 @@ H1 {
}
H2 {
font-size: 120%;
margin-left: 30px;
}
H3 {
font-size: 100%;