Comments (4)
You don't need it on class or module definitions. You can just use Markdown and indent your code & YUIDoc will display it automatically.
from yuidoc.
I like the "Example:" header that was rendered is all.
It seemed logical and there was nothing to warn me it would break.
The desired outcome is that it either works as expected (DWIM) or at least throws an error or warning that the construct is not supported.
As it stands, if you do this the output is mangled.
On May 17, 2012, at 9:46 AM, Dav Glass wrote:
You don't need it on class or module definitions. You can just use Markdown and indent your code & YUIDoc will display it automatically.
Reply to this email directly or view it on GitHub:
#27 (comment)
from yuidoc.
This seems to not work anymore
from yuidoc.
@Flowkap provide a repro case or open a new issue please.
from yuidoc.
Related Issues (20)
- YUIDoc can crash when @file tag is followed by @class tag
- How to document and crosslink my "foo.Object" class?
- error: TypeError: Cannot convert undefined or null to object at DocParser.setter
- Unable to include handlebar example while using block helper within same doc block HOT 2
- @ tag inside the code block is considered as docblock
- crossLink not working HOT 1
- Handlebars statements in code blocks are removed in custom helpers are included
- YUDoc @type doc bug HOT 1
- Unable to add handlebars code block
- request: Generate documentation for private members
- Problems navigating property index on the file system (PJAX problem?) HOT 1
- Support compound type descriptions
- Publish NPM package update based on current master
- Can notes be added?
- Code in preview has first line incorrectly indented.
- Subdependency cryptiles has a security vulnerability
- Documenting generic type parameters?
- TypeError [ERR_INVALID_ARG_TYPE]: The "options" argument must be of type object. Received an instance of Array HOT 12
- npm -g install yuidocjs: Invalid Version: 3.5.0pr2 HOT 1
- yuidoc won't run on Mac with Apple Silicon HOT 1
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 yuidoc.