Commit Graph
48 Commits
Author SHA1 Message Date
PB e0b055e53b Improve window sizing documentation
CMake builds / ${{ matrix.name }} (-DCMAKE_C_COMPILER=cl.exe -DCMAKE_CXX_COMPILER=cl.exe, Ninja, SOME, CONSOLE_ONLY, Windows MSVC, 1, windows-latest) (push) Has been cancelled
CMake builds / ${{ matrix.name }} (-DCMAKE_SYSTEM_NAME=iOS -DCMAKE_FIND_ROOT_PATH=/usr/local -DCMAKE_XCODE_ATTRIBUTE_CODE_SIGNING_ALLOWED=NO, Xcode, OFF, OFF, macOS 14 wxIOS, macos-14) (push) Has been cancelled
CMake builds / ${{ matrix.name }} (Unix Makefiles, ALL, Ubuntu 22.04 wxGTK 3, ubuntu-22.04) (push) Has been cancelled
CMake builds / ${{ matrix.name }} (Xcode, macOS 14 wxOSX, macos-14) (push) Has been cancelled
Mac builds / ${{ matrix.name }} (arm64, --with-cxx=14 --enable-universal_binary=arm64,x86_64 --disable-shared --disable-debug --enable-optimise, wxMac Universal C++14, self-hosted) (push) Has been cancelled
Mac builds / ${{ matrix.name }} (arm64, wxMac ARM with ASAN, self-hosted, true) (push) Has been cancelled
Mac builds / ${{ matrix.name }} (true, x86_64, PKG_CONFIG_LIBDIR=/dev/null, --with-osx_iphone --enable-monolithic --disable-sys-libs --host=i686-apple-darwin_sim --build=x86_64-apple-darwin17.7.0, wxiOS, macos-14, true, true, iphonesimulator) (push) Has been cancelled
Mac builds / ${{ matrix.name }} (x86_64, --disable-sys-libs, wxMac macOS 14, macos-14) (push) Has been cancelled
Mac builds / ${{ matrix.name }} (x86_64, --with-cxx=17 --with-macosx-version-min=10.12 --enable-debug, wxMac Intel C++17, self-hosted) (push) Has been cancelled
Mac Xcode builds / ${{ matrix.name }} (x86_64, Debug, generic/platform=iOS, iOS static Debug, build/osx/wxiphone.xcodeproj, macos-latest, static) (push) Has been cancelled
Mac Xcode builds / ${{ matrix.name }} (x86_64, Release, generic/platform=iOS Simulator, iOS Simulator static, samples/minimal/minimal_iphone.xcodeproj, macos-latest, app-static) (push) Has been cancelled
Mac Xcode builds / ${{ matrix.name }} (x86_64, Release, generic/platform=macOS, macOS dynamic Release, samples/minimal/minimal_cocoa.xcodeproj, self-hosted, app-dynamic) (push) Has been cancelled
MSW builds / wxMSW vs${{ matrix.vsversion }} ${{ matrix.configuration }} ${{ matrix.platform }} (DLL Debug, x64, true, 2022) (push) Has been cancelled
MSW builds / wxMSW vs${{ matrix.vsversion }} ${{ matrix.configuration }} ${{ matrix.platform }} (DLL Release, x64, 2019) (push) Has been cancelled
MSW builds / wxMSW vs${{ matrix.vsversion }} ${{ matrix.configuration }} ${{ matrix.platform }} (Debug, Win32, 2019) (push) Has been cancelled
MSW builds / wxMSW vs${{ matrix.vsversion }} ${{ matrix.configuration }} ${{ matrix.platform }} (Release, arm64, 2022) (push) Has been cancelled
MSW builds / msw-msys2-clang (push) Has been cancelled
MSW cross-builds / ${{ matrix.name }} (--disable-compat32, testing, wxMSW 64 bits) (push) Has been cancelled
MSW cross-builds / ${{ matrix.name }} (--enable-universal --disable-compat32 --disable-debug --disable-optimise, testing, true, wxMSW/Univ) (push) Has been cancelled
MSW cross-builds / ${{ matrix.name }} (stable, wxMSW 32 bits, i686-w64-mingw32) (push) Has been cancelled
Code Checks / Check Spelling (push) Has been cancelled
Code Checks / Check Whitespace (push) Has been cancelled
Code Checks / Check Mixed EOL (push) Has been cancelled
Code Checks / Check C++ Style (push) Has been cancelled
Update Documentation / Update Online Documentation (push) Has been cancelled
Fix the flag name in wxSizerFlags::Shaped() description.

Add a reference to Windows Sizing Overview to Window Layout page and
Sizers Overview.

Add a reference to Sizers Overview to Window Sizing Overview.

Closes #25044.
2025-01-06 22:16:06 +01:00
Vadim Zeitlin 95f16e63d2 Consistently use @see in Doxygen documentation
Although @see was used predominantly, a few places used @sa which is
equivalent to it but less readable, so switch to using @see everywhere.

No real changes.
2023-02-20 23:02:18 +01:00
Vadim Zeitlin 0ef1cdcc21 Remove support for wxMotif
This port hasn't been updated for ages and is not used by anybody any
longer, so remove its code to facilitate maintenance.

Also remove references to this port from the documentation and most of
the other places (VMS-specific descrip.vms files still check for it
because it's not clear how to update them all), including configure.

Regenerate the latter and rebake all makefiles.

Finally document that this port is not available any longer.
2022-10-16 16:39:56 +02:00
Tobias Taschner 1666f58bc6 Change documentation references from OS X to macOS (#1927)
Since OS X 10.12 it has been named macOS so it makes sense
to reference it in documentation as such, even when it
sometimes refers to older versions which were called (Mac) OS X.
2020-07-04 22:08:24 +02:00
Vadim Zeitlin f03878251b Also fix spelling mistakes in the documentation files
Run the same codespell command on docs directory.
2020-06-28 15:30:04 +02:00
Vadim Zeitlin 8fbca5cb70 Remove all trailing spaces
No real changes, just clean up sources by removing trailing spaces from
all the non-generated files.

This should hopefully avoid future commits mixing significant changes
with insignificant whitespace ones.
2019-01-30 17:35:54 +01:00
Blake-Eryx e1a7f56040 Fix spelling and punctuation errors in comments and documentation
Fix several occurrences of misspelling "trivial" as "trival"; use "from"
rather than "than"; add missing articles and commas.

Closes https://github.com/wxWidgets/wxWidgets/pull/874
2018-08-14 17:15:39 +02:00
Tobias Taschner df33c0c491 Drop Mac prefix when referencing OS X.
Apple only refers to OS X and not Mac OS X since 10.8.
2016-02-04 09:54:36 +01:00
Vadim Zeitlin a193a6786d Escape space after "e.g." or "i.e." in the manual.
This fixes formatting of the Doxygen-generated docs (maybe we should just
switch to the civilized spelling of "eg" and "ie" instead?).

See #16744.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@78308 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-12-24 13:57:05 +00:00
Vadim Zeitlin 9b31387508 Merge the changes from 3.0 branch.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@75178 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-11-12 18:06:37 +00:00
Vadim Zeitlin 3f66f6a5b3 Remove all lines containing cvs/svn "$Id$" keyword.
This keyword is not expanded by Git which means it's not replaced with the
correct revision value in the releases made using git-based scripts and it's
confusing to have lines with unexpanded "$Id$" in the released files. As
expanding them with Git is not that simple (it could be done with git archive
and export-subst attribute) and there are not many benefits in having them in
the first place, just remove all these lines.

If nothing else, this will make an eventual transition to Git simpler.

Closes #14487.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74602 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-07-26 16:02:46 +00:00
Vadim Zeitlin 34f5c1053a Update debugging macros overview in the docs.
Describe how the debugging macros really work since 2.9.1, i.e. explain
wxDEBUG_LEVEL and NDEBUG instead of __WXDEBUG__.

Closes #14435.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71887 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-06-30 16:33:14 +00:00
Steve Lamerton 43d53ee501 Update documentation for new library name.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/SOC2011_WEBVIEW@68790 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-08-19 13:30:46 +00:00
Steve Lamerton bf39189b1e Add web documentation category.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/SOC2011_WEBVIEW@68138 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-07-02 17:11:46 +00:00
Vadim Zeitlin 526954c596 Globally use "wxWindows licence" consistently.
Use "wxWindows licence" and not "wxWidgets licence" (the latter doesn't
exist) and consistently spell "licence" using British spelling.

See #12165.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64940 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-07-13 13:29:13 +00:00
Francesco Montorsi d86f721af3 Fix various doxygen warnings
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63713 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-03-19 22:35:30 +00:00
Peter Cawley 3c3ead1d15 Merged GSOC Ribbon work from SOC2009_RIBBON branch into trunk.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61944 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-09-16 12:06:02 +00:00
Vadim Zeitlin 7d9550df50 Define wxDEBUG_LEVEL in both debug and release builds as 1.
By default include assertions and debug logging in both debug and release
builds but disable them in application release builds (when NDEBUG is
defined).

Also update (more accurately, replace) debugging overview.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61886 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-09-12 11:28:52 +00:00
Francesco Montorsi 3b36f093d9 group wxPlatformInfo functions for easier browsing; add more descriptions; link the related function group
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@60841 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-05-31 16:34:13 +00:00
Francesco Montorsi 530cda2fdc remember to users that env vars are hardly usable for IPC :)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59775 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-03-23 15:04:29 +00:00
Francesco Montorsi 530793f0be minimal list of wx CRT wrappers (so doxygen highlights occurrences of wxFunc() if Func() is a std CRT function
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59683 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-03-21 00:40:12 +00:00
Francesco Montorsi 0cc860a2ab add group file for locale functions (was part of r59627)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59643 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-03-20 12:17:45 +00:00
Francesco Montorsi 3c99e2fd1b recategorize many misplaced classes; move lots of classes from miscellaneous [window] category to more specific categories; add the 'Book controls' and the 'Application and system configuration' class groups
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59051 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-02-20 11:34:52 +00:00
Bryan Petty 830b7aa7b2 Fix manual references to the events overview after it's page ID was changed in r58712 (VZ).
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58978 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-02-18 00:19:22 +00:00
Francesco Montorsi 8f182e0a3c document only char* variant of all string utility functions (don't use wxChar nor templates; they're only confusing; add a note for the funcmacro_string group that all functions documented also have wchar_t variants; document wxStrnlen()
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58552 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-01-31 13:58:45 +00:00
Francesco Montorsi eb63011d3f reformat stream overview and provide a description hopefully correct, even if very short, for wxStreamBuffer
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57332 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-12-14 14:51:42 +00:00
Francesco Montorsi dbbca9fdea link class groups with macro groups and provide a brief description for all groups
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57292 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-12-12 18:51:54 +00:00
Francesco Montorsi 6496345c33 document the main event table macros, wxEventType, wxNewEventType; create a new group_funcmacro_events group
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57070 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-12-02 16:34:09 +00:00
Francesco Montorsi 160f78e09d added group 'grid' (fixes #10217)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56917 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-11-22 22:50:39 +00:00
Jaakko Salli de0037976c Fix RCS-IDs
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56125 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-10-06 15:14:06 +00:00
Jaakko Salli bba3f9b5bc A lot of documentation revision. Updated doctest code in propgrid sample to reflect sample code on overview page.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55766 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-09-21 14:13:32 +00:00
Vadim Zeitlin 1c4293cb91 added wxPropertyGrid from Jaakko Salli (#9934)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55576 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-09-12 20:57:41 +00:00
Vadim Zeitlin 79b40dcf07 create a separate category for the conversion classes
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53883 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-05-31 22:35:24 +00:00
Bryan Petty b321b61c10 Reviewed dataobj.h interface header and added wxDataViewCtrl class group.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53173 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-04-15 03:25:23 +00:00
Bryan Petty 29f86fc182 Restored the old Classes by Category page to live side-by-side with the full Classes by Category grouping.
Also changed the license pages to include the actual license files verbatim rather than duplicated in comments.
Cleaned up the Development Tips page a little fixing some minor issues and wrapping at 80 columns.
Recategorized the WXDEBUG_NEW() macro from the RTTI group to the Debugging group.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52972 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-04-02 05:29:12 +00:00
Francesco Montorsi 0f660b35d9 merge "strategies" page with devtips.h; add mention of Bakefile and wx presets in devtips.h; add explanation of the difference between static/shared builds; reorganize the main page of the manual to improve its usability.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52928 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-03-31 13:27:33 +00:00
Bryan Petty 3950d49c4f Finished review/fixes of the rest of the functions and macro categories (Network/User/OS, Process Control, Strings, Threads, and Time).
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52790 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-03-25 07:36:12 +00:00
Bryan Petty 7fa7088e4c Finished review/fixes of Math and Miscellaneous categories of functions and macros.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52743 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-03-23 18:24:32 +00:00
Bryan Petty ef477678f2 Finished review/fixes of Logging category of functions and macros.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52726 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-03-23 06:25:01 +00:00
Bryan Petty a055a11641 Finished review/fixes of GDI category of functions and macros.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52630 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-03-20 06:00:05 +00:00
Bryan Petty 1ba0de2efa Removed docs for old clipboard functions, and reviewed/fixed atomic ops, file & directory, and environment function categories.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52620 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-03-19 08:02:01 +00:00
Bryan Petty 8f5b44d805 Removed layout constaints related docs as discussed on wx-dev.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52555 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-03-16 00:02:39 +00:00
Bryan Petty 9579c1d7bb Categorized all functions and macros in the Debugging and Version categories.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52538 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-03-15 03:14:51 +00:00
Bryan Petty dae2800ac8 Added the function and macro group pages for Doxygen.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52477 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-03-14 05:47:17 +00:00
Francesco Montorsi 4cbfec1580 revised archive header; changed overview_arc to overview_archive which reads better; modified the @category alias to point to the group pages and to spit out the @ingroup command
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52468 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-03-13 16:30:38 +00:00
Bryan Petty 6e7f563b52 Added the class group pages for Doxygen.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52464 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-03-13 02:56:21 +00:00
Bryan Petty 3db7c3b1aa Added class groups example to Doxygen and added parent "Functions and Macros", and "Classes by Category" groups.
Also added CSS to add "Categories / " to the "Modules" tab label, and turned on DETAILS_AT_TOP setting.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52454 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-03-12 19:08:48 +00:00
Bryan Petty c83e60aab5 Looking for comments on new functions and macros organization of Doxygen docs shown with this commit, see wx-dev.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52438 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-03-11 07:57:21 +00:00