Let's add a documentation
to our Todo
list application in Chapter 1, Getting Started with JavaScriptMVC.
To add the main documentation page, create a Markdown file todo.md
in the Todo/todo
directory with the following content:
@page index TodoApp @description TodoApp is simple todo application. # TodoApp documentation Here we can add some more documentation formatted by [Markdown][1]! [1]: http://daringfireball.net/projects/markdown/syntax "Check out Markdown syntax"
Then, add these documentation blocks to the todo.js
file:
steal( 'jquery/class', 'jquery/model', 'jquery/util/fixture', 'jquery/view/ejs', 'jquery/controller', 'jquery/controller/route', function ($) { /** * @class Todo * @parent index * @constructor * @author Wojciech Bednarski * Creates a new todo. */ $.Model('Todo',{ /** * @function findAll * Get all...