Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add JSDocs to all the Marionette Classes #1652

Closed
samccone opened this issue Jul 15, 2014 · 7 comments

Comments

Projects
None yet
4 participants
@samccone
Copy link
Member

commented Jul 15, 2014

  • Application (Jmeas - #1660)
  • Approuter
  • Behavior
  • Behaviors
  • Callbacks
  • CollectionView
  • CompositeView
  • Configuration
  • Controller
  • Functions
  • Helpers (cmaher - #1668)
  • ItemView
  • LayoutView
  • Module
  • Region (jfairbank)
  • RegionManager
  • Renderer
  • Templatecache
  • View

@samccone samccone added the docs label Jul 15, 2014

@jamesplease

This comment has been minimized.

Copy link
Member

commented Jul 15, 2014

Issues:

  1. JSDoc isn't all that flexible. According to @thejameskyle returns a rendered template, which is kinda dumb. To make matters worse, it seems difficult to make a custom template. Dox is an alternative that supports the same syntax but gives us back JSON.
  2. What will these comments do to our annotated source?
@samccone

This comment has been minimized.

Copy link
Member Author

commented Jul 15, 2014

  1. yep we can use dox to generate the final output for the page
  2. we can customize the output of the annotated source via stripping whatever we do not want
@jasonLaster

This comment has been minimized.

Copy link
Member

commented Jul 15, 2014

creating a json representation can also mean pulling in other interesting information. Forexample, I can see running a grasp search for all of the triggerMethods, the method they're in and the arguments.

@jamesplease jamesplease changed the title Add JSDocs to all the methods Add JSDocs to all the Marionette Classes Jul 16, 2014

@jamesplease

This comment has been minimized.

Copy link
Member

commented Jul 16, 2014

We should probably look into adding jscs for checking our JSDoc syntax.

//cc @thejameskyle.

@jamiebuilds

This comment has been minimized.

Copy link
Member

commented Jul 16, 2014

@jmeas What does jscs do for that?

@jamiebuilds

This comment has been minimized.

Copy link
Member

commented Jul 16, 2014

@jamesplease

This comment has been minimized.

Copy link
Member

commented Aug 23, 2014

Closing in favor of #1756

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.