cpp-tizen-client.doc-readme.mustache Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of openapi-generator Show documentation
There is a newer version: 7.7.0
# Documentation for {{#openAPI}}{{#info}}{{title}} {{version}} Tizen Client SDK{{/info}}{{/openAPI}}

## How do I get the doc files?
First generate source code by running `openapi-generator`
Then run `doc/generateDocumentation.sh` from the output folder. It will generate all the doc files and put them in the `doc/SDK` directory.
To successfully generate documentation it needs `Doxygen` installed in the path.
*Note* - Before generating the documentation, put the logo of the project as the file `doc/logo.png` before running `doxygen`.


## How do I use this?
This is the structure of the doc folder:

```
.
├── logo.png                  \\Logo of the project
├── Doxyfile                  \\Doxygen config files
├── generateDocumentation.sh  \\Script to run to generate documentation
├── README.md                 \\This file
├── SDK                       \\Documentation for all classes in {{#openAPI}}{{#info}}{{title}} Tizen Client SDK{{/info}}{{/openAPI}}. See ./html/index.html
│   └── html

```

## *tl;dr* run this:

```
doc/generateDocumentation.sh
```

The above SDK folder will be generated. See the index.html inside the SDK folder.


## What's Doxygen?
Doxygen is the de facto standard tool for generating/extracting documentation from annotated/unannotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D.

Check out [Doxygen](https://www.doxygen.org/) for additional information about the Doxygen project.

## I Don't want to run Doxygen. What are the API files for accessing the REST endpoints?
All URIs are relative to {{{scheme}}}://{{{host}}}{{{basePath}}}
{{#apiInfo}}{{#apis}}{{#operations}}

### {{classname}}
Method | HTTP request | Description
------------- | ------------- | -------------
{{#operation}}
*{{operationId}}Sync* | *{{httpMethod}}* {{{path}}} | {{{summary}}}.
*{{operationId}}ASync* | *{{httpMethod}}* {{{path}}} | {{{summary}}}.
{{/operation}}
{{/operations}}{{/apis}}{{/apiInfo}}

## What are the Model files for the data structures/objects?
Class | Description
------------- | -------------
{{#models}}{{#model}} *{{classname}}* | {{{description}}}
{{/model}}{{/models}}