expect.md

MyClass()

A useful class

This is exported (isExport must be true)

author Jean Ponchon

MyClass#createUser(name, groupId, [options])

Create new user

Long description of this method with list and examples

• Do this
• And this

Example:

var my = new MyClass();
my.createUser('Foo',['admin','staff'], { silent: true });

Parameters:

• name {String} Username with some restrictions

  • Must be lower-case
  • Must be funny

• groupId {String|String[]} Group id or array of group id Put some markdow here too:

  // Example
  function() { ... }
  

• [options] {Object} Options are always optional but params description alignement is based on first line indentation

returns {Boolean}

thows {InvalidUsernameException} funny (maybe)

see http://www.gelule.net/

MyClass#isCompacter([options])

Summary in a short and compact documentation

Long description of this method

Parameters:

• [options] {Object}

returns {Boolean}