TestQDoc::Test Class

Member Function Documentation

void (*)(bool) Test::funcPtr(bool b, const char *s)

Returns a pointer to a function that takes a boolean. Uses b and s.

[protected] template <typename T1, typename T2> void Test::funcTemplate(T1 a, T2 b)

Function template with two parameters, a and b.

void Test::inlineFunction()

An inline function, documented using the \fn QDoc command.

void Test::methodWithEmDashInItsDocs()

This method has em dashes in its documentation—as you'll find represented by --- in the sources—here and there. The important bit to note is that when passed e.g. to the \c command, the three hyphens are processed as input to the command and not replaced by an em dash.

-----------------------------------------------------------------------

People can still add a bunch of dashes, though, without QDoc replacing them all with a series of em dashes.

—You can also start a new paragraph with an em dash, if you want to.

See also methodWithEnDashInItsDocs.

void Test::methodWithEnDashInItsDocs()

This method has en dashes in its documentation – as you'll find represented by -- in the sources – here and there. The important bit to note is that when passed e.g. to the \c command, the two hyphens are processed as input to the command and not replaced by an en dash. This also applies to code blocks, where otherwise, the decrement operator would get completely borked:

for (int i = 42; i > 0; --i)
    // Do something cool during countdown.

...as it would be silly if this would output –i instead of --i.

-----------------------------------------------------------------------

It still allows people to add a bunch of dashes, though, without replacing them all with a series of en dashes. Of course, they might want to use the \hr command instead, like this:

---

– You can also start a new paragraph with an en dash, if you want to.

See also methodWithEnDashInItsDocs.

Overloads that share a documentation comment, optionally taking a parameter b.

int Test::someFunction(int, int v = 0)

Function that takes a parameter v. Also returns the value of v.

void Test::someFunctionDefaultArg(int i, bool b = false) const

Function that takes a parameter i and b.

Warning: This function is not reentrant.

[virtual] void Test::virtualFun()

Function that must be reimplemented.