Commit Graph

17 Commits

Author SHA1 Message Date
Artur Wieczorek
5925893eed Fix various doxygen issues in the documentation 2019-10-20 11:53:49 +02:00
Scott Talbert
c68e5d0617 Fix some spelling/grammar errors in documentation
Mostly replace ungrammatical "allows to do" with correct "allows doing".

Closes https://github.com/wxWidgets/wxWidgets/pull/1183
2019-01-26 03:50:47 +01:00
Jan Niklas Hasse
496da2e550 Remove trailing whitespace from several files
No real changes.

See https://github.com/wxWidgets/wxWidgets/pull/787
2018-04-18 15:45:42 +02:00
Lauri Nurmi
b8192cb8e1 Allow hiding command line arguments from Usage()
Add wxCMD_LINE_HIDDEN wxCmdLineParser flag allowing to hide options and/or
parameters.

A hidden/unlisted argument is processed as usual, but not shown in the output
given by Usage(). A use case for such could be diagnostics switches that
should exist but are not useful to the end user.

Closes https://github.com/wxWidgets/wxWidgets/pull/390
2017-02-20 17:53:04 +01:00
Vadim Zeitlin
5cfbf0dc4d Allow iterating over wxCmdLineParser arguments in order.
This allows the meaning of the options to depend on their order relatively to
the other options which wasn't possible before.

See http://review.bakefile.org/r/557/

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@75723 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-01-28 13:04:55 +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
3746766367 Fix for special characters in Doxygen comments.
Escape "-" characters in the beginning of the paragraph as they are not
handled properly by Doxygen otherwise.

Escape the space after "i.e." to prevent the brief doc string from being
terminated by it.

Escape "--" which is translated to a dash by Doxygen otherwise.

Closes #15228.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74064 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-05-31 23:20:53 +00:00
Vadim Zeitlin
5f4994df03 Added convenient wxCmdLineParser::AddLong{Option,Switch}() wrappers.
The new functions simply call Add{Option,Switch}() with an empty first
argument but using them makes the code more readable.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@69797 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-11-22 13:18:58 +00:00
Vadim Zeitlin
a6bf0c9533 Add support for negatable command line switches.
Add wxCMD_LINE_SWITCH_NEGATABLE which allows to use a dash after a command
line switch to inverse its meaning (i.e. use "/X-" form). Also add new
wxCmdLineParser::FoundSwitch() allowing to check for whether the switch was
specified in normal or negated form.

Closes #11643.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@66253 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-11-24 00:42:53 +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
7bdb010f17 better docs for wxCmdLineParser (fixes a few typos, adds more comments)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59751 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-03-22 23:29:14 +00:00
Francesco Montorsi
3d46a376b1 distribute in the right places documentations for the overloads/structs used with wxCmdLineParser; mention wxAppConsole::OnInitCmdLine and wxAppConsole::OnCmdLineParsed
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57331 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-12-14 14:06:47 +00:00
Francesco Montorsi
920b92a3fd few other fixes for wxChar => wxString
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56889 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-11-22 10:41:52 +00:00
Francesco Montorsi
c0e97a5ec4 small changes to fix doxygen warnings
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55862 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-09-25 14:07:25 +00:00
Vadim Zeitlin
a4761b4c08 implement flag for Unix-like behaviour in wxCmdLineParser::ConverStringToArgs()
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54648 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-07-16 00:49:25 +00:00
Bryan Petty
12f5e1e78f Commit 3 of 3 for Doxygen path fixes, this one finally removes all 600+ unnecessary uses of @wxheader and @headerfile.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54387 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-06-27 18:00:03 +00:00
Bryan Petty
ae3c17b401 Moved all interface headers into a 'wx' subdirectory for proper use of Doxygen path settings.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54385 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-06-27 16:22:58 +00:00