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

Merge branch 'im/doxyfix2' of https://github.com/imciner2/wxWidgets

Browse Source 
Fix various documentation problems.

See https://github.com/wxWidgets/wxWidgets/pull/2367
This commit is contained in:
Vadim Zeitlin
2021-05-31 15:16:43 +02:00
parent 5dbdada6aa 3a6c62a965
commit 58cbad1bc9
17 changed files with 193 additions and 221 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/doxygen/Doxyfile
View File

@@ -174,6 +174,12 @@ ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
ALIASES += row3col{11}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10,\11</td></tr>"
ALIASES += row3col{12}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10,\11,\12</td></tr>"
ALIASES += row3col{13}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10,\11,\12,\13</td></tr>"
ALIASES += row3col{14}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10,\11,\12,\13,\14</td></tr>"
ALIASES += row3col{15}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10,\11,\12,\13,\14,\15</td></tr>"
ALIASES += row3col{16}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10,\11,\12,\13,\14,\15,\16</td></tr>"
ALIASES += hdr3col{3}="<tr><th>\1</th> <th>\2</th> <th>\3</th></tr>"
ALIASES += endTable="</table>"
@@ -194,7 +200,7 @@ ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4
ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
ALIASES += endDefList="</table>"
ALIASES += stock{3}="<tr><td><span class='itemdef'>\1</span></td> <td> @image html gtk-\2.png\n</td><td>\3</td></tr>"
ALIASES += stock{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td> <td> @image html gtk-\3.png </td></tr>"
# Aliases for documenting wxPerl/wxPython-specific parts
#---------------------------------------------------------------------------

146
docs/doxygen/mainpages/const_stockitems.h
View File

@@ -19,79 +19,79 @@ automatically add stock bitmaps when using stock IDs.
Also note that you can retrieve stock bitmaps using wxArtProvider.
@beginDefList
@row3col{<b>Stock ID</b>, <b>GTK icon</b>, <b>Stock label</b>}
@stock{wxID_ABOUT,about,&About}
@stock{wxID_ADD,add,Add}
@stock{wxID_APPLY,apply,&Apply}
@stock{wxID_BACKWARD,go-back-ltr,&Back}
@stock{wxID_BOLD,bold,&Bold}
@stock{wxID_BOTTOM,goto-bottom,&Bottom}
@stock{wxID_CANCEL,cancel,&Cancel}
@stock{wxID_CDROM,cdrom,&CD-ROM}
@stock{wxID_CLEAR,clear,&Clear}
@stock{wxID_CLOSE,close,&Close}
@stock{wxID_CONVERT,convert,&Convert}
@stock{wxID_COPY,copy,&Copy}
@stock{wxID_CUT,cut,Cu&t}
@stock{wxID_DELETE,delete,&Delete}
@stock{wxID_DOWN,go-down,&Down}
@stock{wxID_EDIT,edit,&Edit}
@stock{wxID_EXECUTE,execute,&Execute}
@stock{wxID_EXIT,quit,&Quit}
@stock{wxID_FILE,file,&File}
@stock{wxID_FIND,find,&Find...}
@stock{wxID_FIRST,goto-first-ltr,&First}
@stock{wxID_FLOPPY,floppy,&Floppy}
@stock{wxID_FORWARD,go-forward-ltr,&Forward}
@stock{wxID_HARDDISK,harddisk,&Harddisk}
@stock{wxID_HELP,help,&Help}
@stock{wxID_HOME,home,&Home}
@stock{wxID_INDENT,indent-ltr,Indent}
@stock{wxID_INDEX,index,&Index}
@stock{wxID_INFO,info,&Info}
@stock{wxID_ITALIC,italic,&Italic}
@stock{wxID_JUMP_TO,jump-to-ltr,&Jump to}
@stock{wxID_JUSTIFY_CENTER,justify-center,Centered}
@stock{wxID_JUSTIFY_FILL,justify-fill,Justified}
@stock{wxID_JUSTIFY_LEFT,justify-left,Align Left}
@stock{wxID_JUSTIFY_RIGHT,justify-right,Align Right}
@stock{wxID_LAST,goto-last-ltr,&Last}
@stock{wxID_NETWORK,network,&Network}
@stock{wxID_NEW,new,&New}
@stock{wxID_NO,no,&No}
@stock{wxID_OK,ok,&OK}
@stock{wxID_OPEN,open,&Open...}
@stock{wxID_PASTE,paste,&Paste}
@stock{wxID_PREFERENCES,preferences,&Preferences}
@stock{wxID_PREVIEW,print-preview,Print previe&w}
@stock{wxID_PRINT,print,&Print...}
@stock{wxID_PROPERTIES,properties,&Properties}
@stock{wxID_REDO,redo-ltr,&Redo}
@stock{wxID_REFRESH,refresh,Refresh}
@stock{wxID_REMOVE,remove,Remove}
@stock{wxID_REPLACE,find-and-replace,Rep&lace...}
@stock{wxID_REVERT_TO_SAVED,revert-to-saved-ltr,Revert to Saved}
@stock{wxID_SAVE,save,&Save}
@stock{wxID_SAVEAS,save-as,Save &As...}
@stock{wxID_SELECTALL,select-all,Select &All}
@stock{wxID_SELECT_COLOR,select-color,&Color}
@stock{wxID_SELECT_FONT,select-font,&Font}
@stock{wxID_SORT_ASCENDING,sort-ascending,&Ascending}
@stock{wxID_SORT_DESCENDING,sort-descending,&Descending}
@stock{wxID_SPELL_CHECK,spell-check,&Spell Check}
@stock{wxID_STOP,stop,&Stop}
@stock{wxID_STRIKETHROUGH,strikethrough,&Strikethrough}
@stock{wxID_TOP,goto-top,&Top}
@stock{wxID_UNDELETE,undelete-ltr,Undelete}
@stock{wxID_UNDERLINE,underline,&Underline}
@stock{wxID_UNDO,undo-ltr,&Undo}
@stock{wxID_UNINDENT,unindent-ltr,&Unindent}
@stock{wxID_UP,go-up,&Up}
@stock{wxID_YES,yes,&Yes}
@stock{wxID_ZOOM_100,zoom-100,&Actual Size}
@stock{wxID_ZOOM_FIT,zoom-fit,Zoom to &Fit}
@stock{wxID_ZOOM_IN,zoom-in,Zoom &In}
@stock{wxID_ZOOM_OUT,zoom-out,Zoom &Out}
@row3col{<b>Stock ID</b>, <b>Stock label</b>, <b>GTK icon</b>}
@stock{wxID_ABOUT,&About,about}
@stock{wxID_ADD,Add,add}
@stock{wxID_APPLY,&Apply,apply}
@stock{wxID_BACKWARD,&Back,go-back-ltr}
@stock{wxID_BOLD,&Bold,bold}
@stock{wxID_BOTTOM,&Bottom,goto-bottom}
@stock{wxID_CANCEL,&Cancel,cancel}
@stock{wxID_CDROM,&CD-ROM,cdrom}
@stock{wxID_CLEAR,&Clear,clear}
@stock{wxID_CLOSE,&Close,close}
@stock{wxID_CONVERT,&Convert,convert}
@stock{wxID_COPY,&Copy,copy}
@stock{wxID_CUT,Cu&t,cut}
@stock{wxID_DELETE,&Delete,delete}
@stock{wxID_DOWN,&Down,go-down}
@stock{wxID_EDIT,&Edit,edit}
@stock{wxID_EXECUTE,&Execute,execute}
@stock{wxID_EXIT,&Quit,quit}
@stock{wxID_FILE,&File,file}
@stock{wxID_FIND,&Find...,find}
@stock{wxID_FIRST,&First,goto-first-ltr}
@stock{wxID_FLOPPY,&Floppy,floppy}
@stock{wxID_FORWARD,&Forward,go-forward-ltr}
@stock{wxID_HARDDISK,&Harddisk,harddisk}
@stock{wxID_HELP,&Help,help}
@stock{wxID_HOME,&Home,home}
@stock{wxID_INDENT,Indent,indent-ltr}
@stock{wxID_INDEX,&Index,index}
@stock{wxID_INFO,&Info,info}
@stock{wxID_ITALIC,&Italic,italic}
@stock{wxID_JUMP_TO,&Jump to,jump-to-ltr}
@stock{wxID_JUSTIFY_CENTER,Centered,justify-center}
@stock{wxID_JUSTIFY_FILL,Justified,justify-fill}
@stock{wxID_JUSTIFY_LEFT,Align Left,justify-left}
@stock{wxID_JUSTIFY_RIGHT,Align Right,justify-right}
@stock{wxID_LAST,&Last,goto-last-ltr}
@stock{wxID_NETWORK,&Network,network}
@stock{wxID_NEW,&New,new}
@stock{wxID_NO,&No,no}
@stock{wxID_OK,&OK,ok}
@stock{wxID_OPEN,&Open...,open}
@stock{wxID_PASTE,&Paste,paste}
@stock{wxID_PREFERENCES,&Preferences,preferences}
@stock{wxID_PREVIEW,Print previe&w,print-preview}
@stock{wxID_PRINT,&Print...,print}
@stock{wxID_PROPERTIES,&Properties,properties}
@stock{wxID_REDO,&Redo,redo-ltr}
@stock{wxID_REFRESH,Refresh,refresh}
@stock{wxID_REMOVE,Remove,remove}
@stock{wxID_REPLACE,Rep&lace...,find-and-replace}
@stock{wxID_REVERT_TO_SAVED,Revert to Saved,revert-to-saved-ltr}
@stock{wxID_SAVE,&Save,save}
@stock{wxID_SAVEAS,Save &As...,save-as}
@stock{wxID_SELECTALL,Select &All,select-all}
@stock{wxID_SELECT_COLOR,&Color,select-color}
@stock{wxID_SELECT_FONT,&Font,select-font}
@stock{wxID_SORT_ASCENDING,&Ascending,sort-ascending}
@stock{wxID_SORT_DESCENDING,&Descending,sort-descending}
@stock{wxID_SPELL_CHECK,&Spell Check,spell-check}
@stock{wxID_STOP,&Stop,stop}
@stock{wxID_STRIKETHROUGH,&Strikethrough,strikethrough}
@stock{wxID_TOP,&Top,goto-top}
@stock{wxID_UNDELETE,Undelete,undelete-ltr}
@stock{wxID_UNDERLINE,&Underline,underline}
@stock{wxID_UNDO,&Undo,undo-ltr}
@stock{wxID_UNINDENT,&Unindent,unindent-ltr}
@stock{wxID_UP,&Up,go-up}
@stock{wxID_YES,&Yes,yes}
@stock{wxID_ZOOM_100,&Actual Size,zoom-100}
@stock{wxID_ZOOM_FIT,Zoom to &Fit,zoom-fit}
@stock{wxID_ZOOM_IN,Zoom &In,zoom-in}
@stock{wxID_ZOOM_OUT,Zoom &Out,zoom-out}
@endDefList
Note that some of the IDs listed above also have a stock accelerator and an

4
docs/doxygen/mainpages/const_wxusedef.h
View File

@@ -276,7 +276,7 @@ library:
@itemdef{wxUSE_LIBSDL, Use SDL for wxSound implementation.}
@itemdef{wxUSE_PLUGINS, See also wxUSE_LIBSDL.}
@itemdef{wxUSE_UNIX, Enabled on Unix Platform.}
@itemdef(wxUSE_XTEST, Use XTest extension.}
@itemdef{wxUSE_XTEST, Use XTest extension.}
@endDefList
@@ -327,7 +327,7 @@ library:
@itemdef{wxUSE_DC_CACHEING, cache temporary wxDC objects.}
@itemdef{wxUSE_DDE_FOR_IPC, See wx/ipc.h file.}
@itemdef{wxUSE_DPI_AWARE_MANIFEST, Set the DPI awareness of the application
(0=none, 1=system, 2=per-monitor. Used by CMake and when wxUSE_RC_MANIFEST is enabled.}
(0=none, 1=system, 2=per-monitor). Used by CMake and when wxUSE_RC_MANIFEST is enabled.}
@itemdef{wxUSE_ENH_METAFILE, Use wxEnhMetaFile.}
@itemdef{wxUSE_HOTKEY, Use wxWindow::RegisterHotKey() and wxWindow::UnregisterHotKey}
@itemdef{wxUSE_INKEDIT, Use InkEdit library. Related to Tablet PCs.}

4
docs/doxygen/overviews/install.md
View File

@@ -187,7 +187,7 @@ e.g. if you use `AC_CONFIG_MACRO_DIRS([m4])`).
For applications using Microsoft Visual Studio IDE, simply add the provided
`wxwidgets.props` property sheet file to your project as explained in the
[instructions](@ref #msw_build_apps) and build the project as usual.
[instructions](@ref msw_build_apps) and build the project as usual.
### Other IDEs
@@ -202,4 +202,4 @@ If you use another IDE, under Unix you should run `wx-config --cxxflags` and
`wx-config --libs` commands separately and copy-and-paste their output to the
"Additional preprocessor options" and "Additional linker options" fields in
your IDE, respectively. Under MSW systems you need to configure the IDE using
the instructions in the ["manual setup"](@ref #msw_build_apps) section.
the instructions in the ["manual setup"](@ref msw_build_apps) section.