StarMirror/qTox
1
0
Fork 0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00
Code Issues Projects Releases Wiki Activity

docs(CONTRIBUTING): Changed docs format

Browse Source 
Fix #3559.
This commit is contained in:
Diadlo 2016-08-01 11:31:01 +03:00
parent 31d8e7eef0
commit 2be8929f38
No known key found for this signature in database
GPG Key ID: 5AF9F2E29107C727
1 changed files with 32 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
CONTRIBUTING.md
View File

@ -239,40 +239,46 @@ Don't put docs in .h files, if there is a corresponding .cpp file.
#include "blabla.h" #include "blabla.h"
/** /**
I can be briefly described as well! * @brief I can be briefly described as well!
*/ *
static void method() * And here goes my longer descrption!
*
* @param x Description for the first parameter
* @param y Description for the second paramater
* @return An amazing result
*/
static int example(int x, int y)
{ {
// I'm just a little example. // Function implementation...
} }
/** /**
@class OurClass * @class OurClass
@brief Exists for some reason...!? * @brief Exists for some reason...!?
*
Longer description * Longer description
*/ */
/** /**
@enum OurClass::OurEnum * @enum OurClass::OurEnum
@brief The brief description line. * @brief The brief description line.
*
@var EnumValue1 * @var EnumValue1
means something * means something
*
@var EnumValue2 * @var EnumValue2
means something else * means something else
*
Optional long description * Optional long description
*/ */
/** /**
@fn OurClass::somethingHappened(const QString &happened) * @fn OurClass::somethingHappened(const QString &happened)
@param[in] happened tells what has happened... * @param[in] happened tells what has happened...
@brief This signal is emitted when something has happened in the class. * @brief This signal is emitted when something has happened in the class.
*
Here's an optional longer description of what the signal additionally does. * Here's an optional longer description of what the signal additionally does.
*/ */
``` ```
## No translatable HTML tags ## No translatable HTML tags