swagger-api/swagger-codegen

[C++] Style Guide for C++ API client

Open

#3,203 opened on Jun 23, 2016

View on GitHub
 (7 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: C++Enhancement: Featurehelp wanted

Description

Description

We want the auto-generated C++ API client (Qt5, Tizen, REST SDK) to follow the Google C++ style guide: https://google.github.io/styleguide/cppguide.html

Here are some examples: http://stackoverflow.com/questions/3062277/sample-code-with-examples-for-the-c-google-style-guide

Swagger-codegen version

2.2.0 or later

Suggest a Fix

If anyone from the community has cycle to work on this, please reply to let us know and we'll show you some good starting points.

Contributor guide

Tech stack
cpp
Domain
toolingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
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
C++ programmingGoogle C++ style guideswagger codegen internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the existing C++ templates in the swagger codegen repository (e.g., modules/swagger codegen/src/main/resources/handlebars/cpp/). Identify code style deviations from the Google C++ style guide. Modify the templates to enforce consistent style. Test with generated code for Qt5, Tizen, and REST SDK. Review issues and comments for any prior work.