Comments (6)
From testing at http://daringfireball.net/projects/markdown/dingus, lists and nested lists work, but the (outer) list cannot be indented. I fixed numerous violations in the dojo source related to indentation so I think that if the doc parser just strips the first two tabs, or whatever the indent is on the first line, then things will work.
from js-doc-parse.
Also note that with Neil's parser nested lists were hacked like this (taken from dojo/selector/acme.js):
// * attribute queries:
// | * `[foo]` attribute presence selector
// | * `[foo='bar']` attribute value exact match
// | * `[foo~='bar']` attribute value list item match
// | * `[foo^='bar']` attribute start match
// | * `[foo$='bar']` attribute end match
// | * `[foo*='bar']` attribute substring match
That doesn't work anymore either.
from js-doc-parse.
I'll work on a patch for this.
The first problem is here:
function processStandardKey(/**Object*/ metadata, /**string*/ key, /**string*/ line) {
key = standardKeys[key];
line = trim(line);
It's indiscriminately trimming all leading whitespace, where it should only be trimming the indent of the value (by our standards, two tabs). That value isn't being recorded at all, so this is more of a case of an unimplemented feature than a bug.
The second issue is that you are expanding tabs to 2 spaces, rather than 4. Not only do dojo developers use 4 spaces for tabs, but markdown requires 4 spaces for indenting lists (and we are using tabs to indent nested lists). Actually, it's more complicated than that, because for something like "//\t" it should expand to 2 spaces.
from js-doc-parse.
https://github.com/wkeese/js-doc-parse/tree/dojodoc
I'll do some more checking tomorrow though, to make sure everything is OK, and maybe work on the return codes problem too.
from js-doc-parse.
OK, that's the patch, seems to be working, @AdrianVasiliu you see any issues?
from js-doc-parse.
Same as #59
from js-doc-parse.
Related Issues (20)
- return query(...) // dojo/NodeList not working HOT 2
- property's summary gets assigned to the property's value HOT 4
- monkey-patched functions erase original function doc HOT 4
- fx.js makes other file lose easing and duration kwargs definition HOT 3
- kwargs definition using declare() to extend from plain function() broken HOT 1
- inline expansion of union types with kwargs doesn't work HOT 2
- comment on line declaring export variable masks summary HOT 3
- fragile regex for union types HOT 1
- inline return types often ignored HOT 1
- properties added from one module to another sometimes don't show up HOT 1
- dojodoc for properties with dashes ignored HOT 1
- js-doc-parser errors HOT 2
- Ubuntu/Canonical process.execPath = /usr/bin/nodejs HOT 1
- Add support for documenting attach points and attach events HOT 2
- tree.json no longer generated HOT 1
- ERR: TypeError: Object true has no method 'match' HOT 6
- parse.bat config = ./config.js produces error "ERR: TypeError: Object true has no method 'match'" HOT 1
- dynamic AMD require
- js-doc-parse traces when require()ing external url
- UMD modules 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 js-doc-parse.