From 54853c5f66288a82fc77e4e8c3e01a8565073436 Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Thu, 11 Sep 2014 11:57:14 +0200 Subject: Doc: Use title case in section1 titles MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Using Python script title-cased.py Task-number: QTBUG-41250 Change-Id: I00d3d7a0b30db7304a7904efd6d63abd9a7b493b Reviewed-by: Topi Reiniö --- src/corelib/doc/src/objectmodel/properties.qdoc | 2 +- src/corelib/global/qglobalstatic.cpp | 6 +++--- src/corelib/io/qdatastream.cpp | 6 +++--- src/corelib/io/qfileselector.cpp | 4 ++-- src/corelib/io/qloggingcategory.cpp | 8 ++++---- src/corelib/kernel/qobject.cpp | 4 ++-- src/corelib/thread/qthread.cpp | 2 +- src/corelib/tools/qalgorithms.qdoc | 2 +- src/corelib/tools/qelapsedtimer.cpp | 2 +- src/corelib/tools/qlist.cpp | 2 +- src/corelib/tools/qregularexpression.cpp | 18 +++++++++--------- src/corelib/tools/qscopedpointer.cpp | 2 +- src/corelib/tools/qshareddata.cpp | 2 +- src/corelib/tools/qsharedpointer.cpp | 2 +- src/corelib/tools/qstringiterator.qdoc | 4 ++-- src/corelib/tools/qstringlist.cpp | 6 +++--- src/corelib/xml/qxmlstream.cpp | 4 ++-- 17 files changed, 38 insertions(+), 38 deletions(-) (limited to 'src/corelib') diff --git a/src/corelib/doc/src/objectmodel/properties.qdoc b/src/corelib/doc/src/objectmodel/properties.qdoc index 1a79a622b3..8a6c7f53d9 100644 --- a/src/corelib/doc/src/objectmodel/properties.qdoc +++ b/src/corelib/doc/src/objectmodel/properties.qdoc @@ -226,7 +226,7 @@ In the example, the enumeration type that is the property type is declared in MyClass and registered with the \l{Meta-Object System} using the Q_ENUMS() macro. This makes the enumeration values - available as strings for use as in the call to setProperty(). Had + available as strings for use as in the call to \l{QObject::}{setProperty()}. Had the enumeration type been declared in another class, its fully qualified name (i.e., OtherClass::Priority) would be required, and that other class would also have to inherit QObject and register diff --git a/src/corelib/global/qglobalstatic.cpp b/src/corelib/global/qglobalstatic.cpp index 4e8ad2f837..3f7aea60b8 100644 --- a/src/corelib/global/qglobalstatic.cpp +++ b/src/corelib/global/qglobalstatic.cpp @@ -84,7 +84,7 @@ whether the type has already been destroyed, to avoid the use-after-destruction problem (see QGlobalStatic::isDestroyed()). - \section1 Constructor and destructor + \section1 Constructor and Destructor For Q_GLOBAL_STATIC, the type \c Type must be publicly default-constructible and publicly destructible. For @@ -156,7 +156,7 @@ This macro will work, but it will add unnecessary overhead. - \section1 Reentrancy, thread-safety, deadlocks, and exception-safety on construction + \section1 Reentrancy, Thread-safety, Deadlocks, and Exception-safety on Construction The Q_GLOBAL_STATIC macro creates an object that initializes itself on first use in a thread-safe manner: if multiple threads attempt to @@ -224,7 +224,7 @@ \li the object was always created on the heap. \endlist - \section1 Implementation details + \section1 Implementation Details Q_GLOBAL_STATIC is implemented by creating a QBasicAtomicInt called the \c guard and a free, inline function called \c innerFunction. The guard diff --git a/src/corelib/io/qdatastream.cpp b/src/corelib/io/qdatastream.cpp index c3f230be5c..49526ea2d5 100644 --- a/src/corelib/io/qdatastream.cpp +++ b/src/corelib/io/qdatastream.cpp @@ -133,7 +133,7 @@ QT_BEGIN_NAMESPACE special requirements. \target raw - \section1 Reading and writing raw binary data + \section1 Reading and Writing Raw Binary Data You may wish to read/write your own raw binary data to/from the data stream directly. Data may be read from the stream into a @@ -149,14 +149,14 @@ QT_BEGIN_NAMESPACE data, followed by the data. Note that any encoding/decoding of the data (apart from the length quint32) must be done by you. - \section1 Reading and writing Qt collection classes + \section1 Reading and Writing Qt Collection Classes The Qt container classes can also be serialized to a QDataStream. These include QList, QLinkedList, QVector, QSet, QHash, and QMap. The stream operators are declared as non-members of the classes. \target Serializing Qt Classes - \section1 Reading and writing other Qt classes. + \section1 Reading and Writing Other Qt Classes In addition to the overloaded stream operators documented here, any Qt classes that you might want to serialize to a QDataStream diff --git a/src/corelib/io/qfileselector.cpp b/src/corelib/io/qfileselector.cpp index a465f93c61..5d1d5dfe23 100644 --- a/src/corelib/io/qfileselector.cpp +++ b/src/corelib/io/qfileselector.cpp @@ -140,7 +140,7 @@ QFileSelectorPrivate::QFileSelectorPrivate() deployment step as an optimization. As selectors come with a performance cost, it is recommended to avoid their use in circumstances involving performance-critical code. - \section1 Adding selectors + \section1 Adding Selectors Selectors normally available are \list @@ -158,7 +158,7 @@ QFileSelectorPrivate::QFileSelectorPrivate() future calls to select(). If the extra selectors list has been changed, calls to select() will use the new list and may return differently. - \section1 Conflict resolution when multiple selectors apply + \section1 Conflict Resolution when Multiple Selectors Apply When multiple selectors could be applied to the same file, the first matching selector is chosen. The order selectors are checked in are: diff --git a/src/corelib/io/qloggingcategory.cpp b/src/corelib/io/qloggingcategory.cpp index 0b55f2376a..37503e032c 100644 --- a/src/corelib/io/qloggingcategory.cpp +++ b/src/corelib/io/qloggingcategory.cpp @@ -71,14 +71,14 @@ static void setBoolLane(QBasicAtomicInt *atomic, bool enable, int shift) boundaries, nor to manipulate the objects directly, nor to inherit from QLoggingCategory. - \section1 Creating category objects + \section1 Creating Category Objects The Q_DECLARE_LOGGING_CATEGORY() and Q_LOGGING_CATEGORY() macros conveniently declare and create QLoggingCategory objects: \snippet qloggingcategory/main.cpp 1 - \section1 Checking category configuration + \section1 Checking Category Configuration QLoggingCategory provides \l isDebugEnabled(), \l isWarningEnabled(), \l isCriticalEnabled(), as well as \l isEnabled() @@ -90,7 +90,7 @@ static void setBoolLane(QBasicAtomicInt *atomic, bool enable, int shift) \snippet qloggingcategory/main.cpp 4 - \section1 Default category configuration + \section1 Default Category Configuration Both the QLoggingCategory constructor and the Q_LOGGING_CATEGORY() macro accept an optional QtMsgType argument, which disables all message types with @@ -172,7 +172,7 @@ static void setBoolLane(QBasicAtomicInt *atomic, bool enable, int shift) custom filter via \l installFilter(). All filter rules are ignored in this case. - \section1 Printing the category + \section1 Printing the Category Use the \c %{category} place holder to print the category in the default message handler: diff --git a/src/corelib/kernel/qobject.cpp b/src/corelib/kernel/qobject.cpp index 65b22021fd..337ea7da3c 100644 --- a/src/corelib/kernel/qobject.cpp +++ b/src/corelib/kernel/qobject.cpp @@ -678,7 +678,7 @@ void QMetaCallEvent::placeMetaCall(QObject *object) will remain in the old thread when moveToThread() is called. \target No copy constructor - \section1 No copy constructor or assignment operator + \section1 No Copy Constructor or Assignment Operator QObject has neither a copy constructor nor an assignment operator. This is by design. Actually, they are declared, but in a @@ -723,7 +723,7 @@ void QMetaCallEvent::placeMetaCall(QObject *object) and both standard Qt widgets and user-created forms can be given dynamic properties. - \section1 Internationalization (i18n) + \section1 Internationalization (I18n) All QObject subclasses support Qt's translation features, making it possible to translate an application's user interface into different languages. diff --git a/src/corelib/thread/qthread.cpp b/src/corelib/thread/qthread.cpp index 6bb3f934a1..3caad7c4b2 100644 --- a/src/corelib/thread/qthread.cpp +++ b/src/corelib/thread/qthread.cpp @@ -213,7 +213,7 @@ QThreadPrivate::~QThreadPrivate() \note Care must be taken when interacting with objects across different threads. See \l{Synchronizing Threads} for details. - \section1 Managing threads + \section1 Managing Threads QThread will notifiy you via a signal when the thread is started() and finished(), or you can use isFinished() and diff --git a/src/corelib/tools/qalgorithms.qdoc b/src/corelib/tools/qalgorithms.qdoc index 2551233aec..5e5a2b42e2 100644 --- a/src/corelib/tools/qalgorithms.qdoc +++ b/src/corelib/tools/qalgorithms.qdoc @@ -144,7 +144,7 @@ QList and QVector's non-const iterator types are random access iterators. - \section1 Qt and the STL algorithms + \section1 Qt and the STL Algorithms Historically, Qt used to provide functions which were direct equivalents of many STL algorithmic functions. Starting with Qt 5.0, you are instead diff --git a/src/corelib/tools/qelapsedtimer.cpp b/src/corelib/tools/qelapsedtimer.cpp index cf2b3b4c9d..52875bc9fe 100644 --- a/src/corelib/tools/qelapsedtimer.cpp +++ b/src/corelib/tools/qelapsedtimer.cpp @@ -77,7 +77,7 @@ QT_BEGIN_NAMESPACE \snippet qelapsedtimer/main.cpp 2 - \section1 Reference clocks + \section1 Reference Clocks QElapsedTimer will use the platform's monotonic reference clock in all platforms that support it (see QElapsedTimer::isMonotonic()). This has diff --git a/src/corelib/tools/qlist.cpp b/src/corelib/tools/qlist.cpp index 7ab2ffffd4..8e2bed7a7c 100644 --- a/src/corelib/tools/qlist.cpp +++ b/src/corelib/tools/qlist.cpp @@ -468,7 +468,7 @@ void **QListData::erase(void **xi) value that might not be in the valid range, check that it is less than the value returned by size() but \e not less than 0. - \section1 More members + \section1 More Members If T is a QByteArray, this class has a couple more members that can be used. See the documentation for QByteArrayList for more information. diff --git a/src/corelib/tools/qregularexpression.cpp b/src/corelib/tools/qregularexpression.cpp index cf80d05153..33894927fe 100644 --- a/src/corelib/tools/qregularexpression.cpp +++ b/src/corelib/tools/qregularexpression.cpp @@ -138,7 +138,7 @@ QT_BEGIN_NAMESPACE \snippet code/src_corelib_tools_qregularexpression.cpp 3 - \section1 Pattern options + \section1 Pattern Options The meaning of the pattern string can be modified by setting one or more \e{pattern options}. For instance, it is possible to set a pattern to match @@ -162,7 +162,7 @@ QT_BEGIN_NAMESPACE Please refer to the QRegularExpression::PatternOption enum documentation for more information about each pattern option. - \section1 Match type and match options + \section1 Match Type and Match Options The last two arguments of the match() and the globalMatch() functions set the match type and the match options. The match type is a value of the @@ -177,7 +177,7 @@ QT_BEGIN_NAMESPACE QRegularExpression::MatchOption enum documentation for more details. \target normal matching - \section1 Normal matching + \section1 Normal Matching In order to perform a match you can simply invoke the match() function passing a string to match against. We refer to this string as the @@ -227,7 +227,7 @@ QT_BEGIN_NAMESPACE \snippet code/src_corelib_tools_qregularexpression.cpp 12 \target global matching - \section1 Global matching + \section1 Global Matching \e{Global matching} is useful to find all the occurrences of a given regular expression inside a subject string. Suppose that we want to extract @@ -257,7 +257,7 @@ QT_BEGIN_NAMESPACE the globalMatch() function, exactly like normal matching with match(). \target partial matching - \section1 Partial matching + \section1 Partial Matching A \e{partial match} is obtained when the end of the subject string is reached, but more characters are needed to successfully complete the match. @@ -396,7 +396,7 @@ QT_BEGIN_NAMESPACE text) would have been \c{"abcabc"}; by matching only against the leading \c{"abc"} we instead get a partial match. - \section1 Error handling + \section1 Error Handling It is possible for a QRegularExpression object to be invalid because of syntax errors in the pattern string. The isValid() function will return @@ -415,7 +415,7 @@ QT_BEGIN_NAMESPACE its \l{QRegularExpressionMatch::}{isValid()} function will return false). The same applies for attempting a global match. - \section1 Unsupported Perl-compatible regular expressions features + \section1 Unsupported Perl-compatible Regular Expressions Features QRegularExpression does not support all the features available in Perl-compatible regular expressions. The most notable one is the fact that @@ -424,7 +424,7 @@ QT_BEGIN_NAMESPACE This may change in a future version of Qt. - \section1 Notes for QRegExp users + \section1 Notes for QRegExp Users The QRegularExpression class introduced in Qt 5 is a big improvement upon QRegExp, in terms of APIs offered, supported pattern syntax and speed of @@ -517,7 +517,7 @@ QT_BEGIN_NAMESPACE QRegExp::CaretAtOffset behaviour. There is no equivalent for the other QRegExp::CaretMode modes. - \section1 Debugging code that uses QRegularExpression + \section1 Debugging Code that Uses QRegularExpression QRegularExpression internally uses a just in time compiler (JIT) to optimize the execution of the matching algorithm. The JIT makes extensive diff --git a/src/corelib/tools/qscopedpointer.cpp b/src/corelib/tools/qscopedpointer.cpp index 1f166bb3c3..57829bdd08 100644 --- a/src/corelib/tools/qscopedpointer.cpp +++ b/src/corelib/tools/qscopedpointer.cpp @@ -73,7 +73,7 @@ QT_BEGIN_NAMESPACE \snippet code/src_corelib_tools_qscopedpointer.cpp 2 - \section1 Custom cleanup handlers + \section1 Custom Cleanup Handlers Arrays as well as pointers that have been allocated with \c malloc must not be deleted using \c delete. QScopedPointer's second template parameter diff --git a/src/corelib/tools/qshareddata.cpp b/src/corelib/tools/qshareddata.cpp index a72a99dbe7..37de091776 100644 --- a/src/corelib/tools/qshareddata.cpp +++ b/src/corelib/tools/qshareddata.cpp @@ -222,7 +222,7 @@ QT_BEGIN_NAMESPACE In the member function documentation, \e{d pointer} always refers to the internal pointer to the shared data object. - \section1 Optimize performance for usage in Qt Containers + \section1 Optimize Performance for Usage in Qt Containers You should consider marking your implicitly shared class as a movable type using the Q_DECLARE_TYPEINFO() macro if it resembles the \c Employee class diff --git a/src/corelib/tools/qsharedpointer.cpp b/src/corelib/tools/qsharedpointer.cpp index ed557a05c7..666bc107fa 100644 --- a/src/corelib/tools/qsharedpointer.cpp +++ b/src/corelib/tools/qsharedpointer.cpp @@ -103,7 +103,7 @@ does so weakly. QWeakPointer has the same functionality, but its use for that function is deprecated. - \section1 Optional pointer tracking + \section1 Optional Pointer Tracking A feature of QSharedPointer that can be enabled at compile-time for debugging purposes is a pointer tracking mechanism. When enabled, diff --git a/src/corelib/tools/qstringiterator.qdoc b/src/corelib/tools/qstringiterator.qdoc index 9355191d46..ff0a097cb9 100644 --- a/src/corelib/tools/qstringiterator.qdoc +++ b/src/corelib/tools/qstringiterator.qdoc @@ -69,7 +69,7 @@ respectively after and behind the iterator's current position, but they will not return the code point the iterator has moved through. - \section1 Unicode handling + \section1 Unicode Handling QString and all of its functions work in terms of UTF-16 code units. Unicode code points that fall outside the Basic Multilingual Plane (U+10000 to U+10FFFF) will therefore @@ -91,7 +91,7 @@ a decoding problem; please refer to the each function documentation for more details. - \section1 Unchecked iteration + \section1 Unchecked Iteration It is possible to optimize iterating over a QString contents by skipping some checks. This is in general not safe to do, because a QString is allowed diff --git a/src/corelib/tools/qstringlist.cpp b/src/corelib/tools/qstringlist.cpp index 0f9d427bab..4e5393e0b0 100644 --- a/src/corelib/tools/qstringlist.cpp +++ b/src/corelib/tools/qstringlist.cpp @@ -90,7 +90,7 @@ QT_BEGIN_NAMESPACE \tableofcontents - \section1 Adding strings + \section1 Adding Strings Strings can be added to a list using the \l {QList::append()}{append()}, \l @@ -99,7 +99,7 @@ QT_BEGIN_NAMESPACE \snippet qstringlist/main.cpp 0 - \section1 Iterating over the strings + \section1 Iterating Over the Strings To iterate over a list, you can either use index positions or QList's Java-style and STL-style iterator types: @@ -121,7 +121,7 @@ QT_BEGIN_NAMESPACE QMutableStringListIterator class which is a type definition for QMutableListIterator. - \section1 Manipulating the strings + \section1 Manipulating the Strings QStringList provides several functions allowing you to manipulate the contents of a list. You can concatenate all the strings in a diff --git a/src/corelib/xml/qxmlstream.cpp b/src/corelib/xml/qxmlstream.cpp index 7e03fd4fb5..94f6a8bcde 100644 --- a/src/corelib/xml/qxmlstream.cpp +++ b/src/corelib/xml/qxmlstream.cpp @@ -325,7 +325,7 @@ QXmlStreamEntityResolver *QXmlStreamReader::entityResolver() const namespace prefixes, you can turn off namespace processing completely with the \l namespaceProcessing property. - \section1 Incremental parsing + \section1 Incremental Parsing QXmlStreamReader is an incremental parser. It can handle the case where the document can't be parsed all at once because it arrives in @@ -349,7 +349,7 @@ QXmlStreamEntityResolver *QXmlStreamReader::entityResolver() const stream reader using addData(). Then you call your custom parsing function that reads the XML events from the reader. - \section1 Performance and memory consumption + \section1 Performance and Memory Consumption QXmlStreamReader is memory-conservative by design, since it doesn't store the entire XML document tree in memory, but only the current -- cgit v1.2.3