Jim Schubert 644f720db8
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046)
* [config-help] Sort all outputs

* Remove old/stale generator docs (these have been renamed previously)

* Sort config doc outputs, making it easier to find relevant info

* Fixes cliOptions duplicates

Erlang client/proper improperly set the version option as packageName
(causing duplicate for packageName).

The java and swift option removals are because the options are added in
parent classes, resulting in duplication of the options.

* Add --github-nested-index for generating docs/generators/README.md

* 📝 Regenerate generator docs
2020-01-19 20:19:11 -05:00

107 lines
2.4 KiB
Markdown

---
title: Config Options for objc
sidebar_label: objc
---
| Option | Description | Values | Default |
| ------ | ----------- | ------ | ------- |
|authorEmail|Email to use in the podspec file.| |team@openapitools.org|
|authorName|Name to use in the podspec file.| |OpenAPI|
|classPrefix|prefix for generated classes (convention: Abbreviation of pod name e.g. `HN` for `HackerNews`).`| |OAI|
|coreData|Should generate core data models| |false|
|gitRepoURL|URL for the git repo where this podspec should point to.| |https://github.com/openapitools/openapi-generator|
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|podName|cocoapods package name (convention: CameCase).| |OpenAPIClient|
|podVersion|cocoapods package version.| |1.0.0|
## IMPORT MAPPING
| Type/Alias | Imports |
| ---------- | ------- |
## INSTANTIATION TYPES
| Type/Alias | Instantiated By |
| ---------- | --------------- |
|array|NSMutableArray|
|map|NSMutableDictionary|
## LANGUAGE PRIMITIVES
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>BOOL</li>
<li>NSData</li>
<li>NSDate</li>
<li>NSNumber</li>
<li>NSObject</li>
<li>NSString</li>
<li>NSURL</li>
<li>bool</li>
</ul>
## RESERVED WORDS
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>_packed</li>
<li>authsettings</li>
<li>auto</li>
<li>bodyparam</li>
<li>break</li>
<li>case</li>
<li>cgfloat</li>
<li>char</li>
<li>class</li>
<li>const</li>
<li>continue</li>
<li>default</li>
<li>description</li>
<li>do</li>
<li>double</li>
<li>else</li>
<li>enum</li>
<li>extern</li>
<li>float</li>
<li>for</li>
<li>formparams</li>
<li>goto</li>
<li>headerparams</li>
<li>id</li>
<li>if</li>
<li>implementation</li>
<li>int</li>
<li>interface</li>
<li>localvarfiles</li>
<li>long</li>
<li>nonatomic</li>
<li>nsinteger</li>
<li>nsnumber</li>
<li>nsobject</li>
<li>pathparams</li>
<li>property</li>
<li>protocol</li>
<li>queryparams</li>
<li>readonly</li>
<li>readwrite</li>
<li>register</li>
<li>requestcontenttype</li>
<li>resourcepath</li>
<li>responsecontenttype</li>
<li>retain</li>
<li>return</li>
<li>short</li>
<li>signed</li>
<li>sizeof</li>
<li>static</li>
<li>strong</li>
<li>struct</li>
<li>switch</li>
<li>typedef</li>
<li>union</li>
<li>unsafe_unretained</li>
<li>unsigned</li>
<li>void</li>
<li>volatile</li>
<li>weak</li>
<li>while</li>
</ul>