Clang: clean up documentation markup

This commit is contained in:
Adriaan de Groot 2017-09-10 07:45:42 -04:00
parent 0b39e50cdc
commit 764fb742ba

View File

@ -100,9 +100,9 @@ public:
/**
* @brief instanceKey returns the instance key of this module.
* @return a string with the instance key.
* A module instance's instance key is modulename@instanceid.
* @example "partition@partition" (default configuration) or
* "locale@someconfig" (custom configuration)
* A module instance's instance key is modulename\@instanceid.
* For instance, "partition\@partition" (default configuration) or
* "locale\@someconfig" (custom configuration)
*/
virtual QString instanceKey() const final;