JSDuck - the tool for documenting your Ext JS apps

[renku]

You can simply write:

 @docauthor Some Name <email@example.com>

That's the usual convention how @author tag is used in all Javadoc-style tools.

The current JSDuck implementation for both @author and @docauthor is to simply accept anything until the end of line.

If you want error reporting, you can implement your own @docauthor tag and pass it to JSDuck through --meta-tags option. The custom implementation will then override the builtin one. See Custom tags page in JSDuck wiki.

[lsdriscoll]

Ok thanks, I'm going to have a go at implementing a mailer class. I just started through the hacking guide and I got this error when running rake ext4:

error template/resources/sass/docs-ext.scss (Line 115 of template/extjs/resources/themes/stylesheets/ext4/default/mixins/_frame.scss: Functions may not be defined within control directives or other mixins.)

[renku]

I think you're using an old version of SASS or Compass.

[lsdriscoll]

I've updated both but I still get the same error.

[renku]

Did some testing. It seems you are using Ext 4.0.7 which has some issues with latest SASS. So you should use at least Ext 4.1.0 with JSDuck.

[lsdriscoll]

Yeah, you're right. Thanks .

FYI I accidentally down-voted your last comment. It won't let me undo!

[lsdriscoll]

I don't know if this is a shared issue, all the links within Live Examples to ext resources point to a folder called extjs-build, which doesn't exist in the output directory, meaning no live examples are working.

I'm sorry if this is documented and I'm just missing something.

[renku]

See the Inline examples guide.

The extjs-build/ dir needs to be manually created.

[thejonz]

The link about overrides is no longer valid...

http://docs.sencha.com/architect/2/#!/guide/overrides

(this is the article that used the above link http://docs.sencha.com/architect/2/#!/guide/custom_code)

while I'm at it, the 404 message that asks you to report the error points you to a closed forum.

Oops...

Guide overrides was not found.
Maybe it was renamed to something else? Or maybe your internet connection has failed? This would be sad. Hopefully it's just a bug on our side. Report it to Sencha Forum if you feel so.
Sorry for all this

[renku]

@thejonz: Thanks, will get these things fixed.