Comments (2)
I can't change the default behaviour due to backwards compatibility, but perhaps an option could be added to change this. Something like an enableLinebreaks()
or such.
Alternatively, perhaps we can come up with a way to specify this in the @rest\description
syntax itself. Are there any precedents for such kind of behaviour in other frameworks?
from phpswaggergen.
I don't know. It's tricky because sometimes you might want to break the lines just to have a more readable source code (e.g. you want to limit the lines to 80 characters) while sometimes you want the line break to be kept for the Markdown formatting for Swagger UI.
There is somewhat the same problem if you use a YAML file directly: one line break is ignored (same behavior has your lib), you need an additional empty line to count as a line break in Swagger UI (so basically \n\n becomes \n in the end result).
from phpswaggergen.
Related Issues (19)
- Model inside a model support in response definition HOT 5
- Support for string:uuid HOT 9
- object(xxxx:array(),xxxxx:array()) throws exception HOT 4
- Property definitions should accept further (type-specific) commands HOT 1
- HEAD operation is not supported HOT 3
- Multiple definitions exist for class TestCase HOT 1
- @rest/require should create object on each item HOT 1
- Feature request for support example attribute for elements HOT 4
- Suppress 'exclusive(Max|Min)imum' for unbounded range ends
- additionalProperties support HOT 5
- Comments ignored with docblock (/**) syntax HOT 3
- Insert content of preprocessor variable into documentation
- Associative arrays are cast to objects, not arrays HOT 2
- PHP Parser fails when parsing @rest\property! HOT 1
- PHP 8 error: array and string offset access with curly braces HOT 2
- Default string value with spaces
- parsing error in the example of Swagger documentation HOT 1
- Duplicate properties and parameters are output twice
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from phpswaggergen.