OpenAPITools/openapi-generator

[REQ] [C][Client] Generate document automatically for C client

Open

#8,426 opened on Jan 13, 2021

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Java (26,243 stars) (7,516 forks)batch import
Client: CEnhancement: FeatureHacktoberfesthelp wanted

Description

Describe the solution you'd like

I'd like to add the templates to auto-generate documentation for C client Just like ruby client https://github.com/OpenAPITools/openapi-generator/blob/master/samples/client/petstore/ruby/docs/PetApi.md and C++ generators do.

Contributor guide

Tech stack
c
Domain
documentationapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Mustache templatesOpenAPI Generator codebase structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the Ruby client documentation template at samples/client/petstore/ruby/docs/PetApi.md and the C++ generator's documentation templates. Locate the C client template files under modules/openapi generator/src/main/resources/c/. Define new Mustache template files for generating Markdown documentation similar to the Ruby and C++ examples.