diff options
| author | Kitsune Ral <Kitsune-Ral@users.sf.net> | 2018-07-18 18:39:56 +0900 |
|---|---|---|
| committer | Kitsune Ral <Kitsune-Ral@users.sf.net> | 2018-07-18 18:39:56 +0900 |
| commit | 5e6b4bb975fa9697a6aca001629c65db506a437f (patch) | |
| tree | deeb501bd6b534dc1ce454fb03e2d91e09597770 /lib/csapi/{{base}}.h.mustache | |
| parent | 56480bc96b28356c44547cc3d9ea1afbda9f04f9 (diff) | |
| download | libquotient-5e6b4bb975fa9697a6aca001629c65db506a437f.tar.gz libquotient-5e6b4bb975fa9697a6aca001629c65db506a437f.zip | |
csapi: Doxy-comments thanks to the latest GTAD
Diffstat (limited to 'lib/csapi/{{base}}.h.mustache')
| -rw-r--r-- | lib/csapi/{{base}}.h.mustache | 33 |
1 files changed, 23 insertions, 10 deletions
diff --git a/lib/csapi/{{base}}.h.mustache b/lib/csapi/{{base}}.h.mustache index bd04ff08..38d80669 100644 --- a/lib/csapi/{{base}}.h.mustache +++ b/lib/csapi/{{base}}.h.mustache @@ -10,10 +10,12 @@ namespace QMatrixClient { {{#models}} // Data structures -{{# model}} +{{# model}}{{#description}} + /// {{_}}{{/description}} struct {{name}}{{#parents?}} : {{#parents}}{{name}}{{>cjoin}}{{/parents}}{{/parents?}} { -{{#vars}} {{>maybeOmittableType}} {{nameCamelCase}}; +{{#vars}}{{#description}} /// {{_}} +{{/description}} {{>maybeOmittableType}} {{nameCamelCase}}; {{/vars}} }; {{#in?}} QJsonObject toJson(const {{name}}& pod); @@ -24,24 +26,34 @@ namespace QMatrixClient }; {{/ out?}}{{/model}} {{/models}}{{#operations}} // Operations -{{# operation}} +{{# operation}}{{#summary}} + /// {{summary}}{{#description?}}{{!add a linebreak between summary and description if both exist}} + /// {{/description?}}{{/summary}}{{#description}} + /// {{_}}{{/description}} class {{camelCaseOperationId}}Job : public BaseJob { public:{{#models}} // Inner data structures -{{# model}} +{{# model}}{{#description}} + /// {{_}}{{/description}} struct {{name}}{{#parents?}} : {{#parents}}{{name}}{{>cjoin}}{{/parents}}{{/parents?}} { -{{#vars}} {{>maybeOmittableType}} {{nameCamelCase}}; +{{#vars}}{{#description}} /// {{_}} +{{/description}} {{>maybeOmittableType}} {{nameCamelCase}}; {{/vars}} }; {{/ model}} // Construction/destruction -{{/ models}} +{{/ models}}{{#allParams?}} + /*! {{summary}}{{#allParams}} + * \param {{nameCamelCase}} {{#description}} + * {{_}}{{/description}}{{/allParams}} + */{{/allParams?}} explicit {{camelCaseOperationId}}Job({{#allParams}}{{>joinedParamDecl}}{{/allParams}});{{^bodyParams}} - /** Construct a URL out of baseUrl and usual parameters passed to - * {{camelCaseOperationId}}Job. This function can be used when - * a URL for {{camelCaseOperationId}}Job is necessary but the job + /*! Construct a URL without creating a full-fledged job object + * + * This function can be used when a URL for + * {{camelCaseOperationId}}Job is necessary but the job * itself isn't. */ static QUrl makeRequestUrl(QUrl baseUrl{{#allParams?}}, {{#allParams}}{{>joinedParamDecl}}{{/allParams}}{{/allParams?}}); @@ -49,7 +61,8 @@ namespace QMatrixClient ~{{camelCaseOperationId}}Job() override; // Result properties -{{#allProperties}} +{{#allProperties}}{{#description}} + /// {{_}}{{/description}} {{>maybeCrefType}} {{paramName}}(){{^moveOnly}} const{{/moveOnly}};{{/allProperties}} protected: |