Small Issues

[gisu]

Here a list with smaller Issues.

(used sassdoc@1.0.0-rc.14 & sassdoc@1.0.0-rc.15)

1. Compile never Stops
When i have this comments

//**

The compiler will never stops, but he does nothing

2. No Output

After i removed all //**the Compiler will works

2014-07-10 23:31:01 Folder `doc` successfully removed.
2014-07-10 23:31:01 Folder `doc` successfully generated.
2014-07-10 23:31:01 File `src/scss/.DS_Store` is not a `.scss` file. Omitted.
2014-07-10 23:31:01 File `src/scss/maps/.DS_Store` is not a `.scss` file. Omitted.
2014-07-10 23:31:01 File `src/scss/styles/readme.txt` is not a `.scss` file. Omitted.
2014-07-10 23:31:01 File `src/scss/framework/helper/.DS_Store` is not a `.scss` file. Omitted.
Parser for annotation `include` not found.
Parser for annotation `include` not found.
Parser for annotation `include` not found.
Parser for annotation `include` not found.
Parser for annotation `include` not found.
2014-07-10 23:31:01 4 items documented.
2014-07-10 23:31:01 Folder `src/scss` successfully parsed.
[TypeError: Cannot call method 'toString' of undefined]

Doc folder is generated but completely empty.

3. Command not found

The old Bug is back with Version sassdoc 1.0.0-rc.15

$ sassdoc src/scss doc --verbose
zsh: command not found: sassdoc

[KittyGiraudel]

I think @FWeinb and @valeriangalliat will have some hints for all these issues. Meanwhile, would you mind showing me your input please?

[KittyGiraudel]

Regarding your 3rd issue, this comes from the fact we splitted the Node API from the CLI part in 1.0.0-rc.15. If you want to use SassDoc from the CLI, please install sassdoc-cli.

[gisu]

Ok i will test it

[KittyGiraudel]

The first issue seems to be an issue with scss-comment-parser. I think Fabrice will have a look.

[KittyGiraudel]

The second leaves me a bit confused. I could probably find the issue if I could have a look at your input (a Gist, SassMeister or anything).

[gisu]

My Sass Input is a little bit longer for Sassmeister :D Is my Framework here https://github.com/gisu/molecule (dir src/scss/)

I have installed sassdoc-cli

2014-07-10 23:56:17 Folder `doc` successfully removed.
2014-07-10 23:56:17 Folder `doc` successfully generated.
2014-07-10 23:56:17 File `src/scss/.DS_Store` is not a `.scss` file. Omitted.
2014-07-10 23:56:17 File `src/scss/styles/readme.txt` is not a `.scss` file. Omitted.
2014-07-10 23:56:17 File `src/scss/maps/.DS_Store` is not a `.scss` file. Omitted.
2014-07-10 23:56:17 File `src/scss/framework/helper/.DS_Store` is not a `.scss` file. Omitted.
Parser for annotation `include` not found.
Parser for annotation `include` not found.
Parser for annotation `include` not found.
Parser for annotation `include` not found.
Parser for annotation `include` not found.
2014-07-10 23:56:17 4 items documented.
2014-07-10 23:56:17 Folder `src/scss` successfully parsed.
[TypeError: Cannot call method 'toString' of undefined]

Don't know exactly whats wrong, why the compiler hangs when he call "toString".

[KittyGiraudel]

In order to localize the issue, I suggest you run SassDoc on subfolders one by one, just to see where it crashes. Then I'll be able to check what's wrong.

[KittyGiraudel]

I've been having a look at your code:

This is illegal: https://github.com/gisu/molecule/blob/master/src/scss/framework/helper/_fonts.scss#L110. See doc: https://github.com/SassDoc/sassdoc/wiki/Documentation#returns-synonym-return.

This is illegal: https://github.com/gisu/molecule/blob/master/src/scss/framework/helper/_fonts.scss#L136. Same here: https://github.com/gisu/molecule/blob/master/src/scss/framework/helper/_bem.scss#L39. And here: https://github.com/gisu/molecule/blob/master/src/scss/framework/helper/_bem.scss#L64. And here: https://github.com/gisu/molecule/blob/master/src/scss/framework/helper/_bem.scss#L67. Lines cannot start with @ in @example (unfortunately). Actually, I think a leading space before the '@' sign might work, didn't try.

[gisu]

Ok it works now. Thank you.

[FWeinb]

I will fix the //**bug in cdocparser. I think i can make @annotations work like Hugo said by maintaining the indentation of the block.

[FWeinb]

@gisu thanks for this. All your problems should be taken care of on master.