# Emberjs documentation pages

**URL:** <https://discuss.emberjs.com/t/emberjs-documentation-pages/7977>\
**Category:** Uncategorized\
**Created:** [May 11, 2015, 4:46pm UTC](https://discuss.emberjs.com/t/emberjs-documentation-pages/7977 "2015-05-11T16:46:17Z")\
**Posts on this page:** 7\
**Page:** 1

<div class="post-metadata">

**Author:** ![verstraetem93](https://avatars.discourse-cdn.com/v4/letter/v/d07c76/32.png) [@verstraetem93](https://discuss.emberjs.com/u/verstraetem93)\
**Post date:** [May 11, 2015, 4:46pm UTC](https://discuss.emberjs.com/t/emberjs-documentation-pages/7977/1 "2015-05-11T16:46:17Z")

</div>

Hy,

I have written an Emberjs application and am going to write documentation for it now. I was looking at the documentation pages of ember nad they looked very nice to me. I was wondering if anyone knew how they generated these documentation pages. I see that they have jsDoc comments in the code, but with which tool did they generate html pages from this?

Thanks

---

<div class="post-metadata">

**Author:** ![dennismende](https://sea1.discourse-cdn.com/flex019/user_avatar/discuss.emberjs.com/dennismende/32/9958_2.png) [@dennismende](https://discuss.emberjs.com/u/dennismende)\
**Post date:** [May 11, 2015, 5:51pm UTC](https://discuss.emberjs.com/t/emberjs-documentation-pages/7977/2 "2015-05-11T17:51:37Z")

</div>

I don’t know what they use but we use yuidoc. There is an ember-cli package and it works great.

---

<div class="post-metadata">

**Author:** ![verstraetem93](https://avatars.discourse-cdn.com/v4/letter/v/d07c76/32.png) [@verstraetem93](https://discuss.emberjs.com/u/verstraetem93)\
**Post date:** [May 11, 2015, 6:04pm UTC](https://discuss.emberjs.com/t/emberjs-documentation-pages/7977/3 "2015-05-11T18:04:38Z")

</div>

Thanks, I tried yuidoc and it seems to be working pretty well. Just some configuration.

---

<div class="post-metadata">

**Author:** ![JustinHackin](https://avatars.discourse-cdn.com/v4/letter/j/df788c/32.png) [@JustinHackin](https://discuss.emberjs.com/u/JustinHackin)\
**Post date:** [November 3, 2015, 9:18pm UTC](https://discuss.emberjs.com/t/emberjs-documentation-pages/7977/4 "2015-11-03T21:18:25Z")

</div>

Yes, I’ve found yuidoc does a great job too. One of the ‘tricks’ I adopted was to use the @readOnly flag to denote a computed property. Another one I used was to keep Models, Components, etc. distinct by using i.e. “@namespace Models”.

Does anyone have any good tricks for keeping actions in a different space that ordinary component/controller methods ? EDIT: I opted to add “ACTIONS.” to the start of method names but I still think there may be a better way

Also, I was having a hard time finding a good example open source project that is heavily documented with yuidoc. Can anyone point me to one ?

---

<div class="post-metadata">

**Author:** ![Imran\_Khan](https://sea1.discourse-cdn.com/flex019/user_avatar/discuss.emberjs.com/imran_khan/32/11637_2.png) [@Imran\_Khan](https://discuss.emberjs.com/u/Imran_Khan)\
**Post date:** [November 4, 2015, 3:52am UTC](https://discuss.emberjs.com/t/emberjs-documentation-pages/7977/5 "2015-11-04T03:52:23Z")

</div>

If your code is on github, then checkout

> **[GitHub Pages](https://pages.github.com)**
>
> Websites for you and your projects, hosted directly from your GitHub repository. Just edit, push, and your changes are live.

---

<div class="post-metadata">

**Author:** ![francesconovy](https://sea1.discourse-cdn.com/flex019/user_avatar/discuss.emberjs.com/francesconovy/32/9607_2.png) [@francesconovy](https://discuss.emberjs.com/u/francesconovy)\
**Post date:** [November 4, 2015, 7:11am UTC](https://discuss.emberjs.com/t/emberjs-documentation-pages/7977/6 "2015-11-04T07:11:18Z")

</div>

Well, the Ember API Docs are 😉

Personally, I denote my actions as @event. It may not be 100% correct, but it works fine.

---

<div class="post-metadata">

**Author:** ![Bauke](https://sea1.discourse-cdn.com/flex019/user_avatar/discuss.emberjs.com/bauke/32/12190_2.png) [@Bauke](https://discuss.emberjs.com/u/Bauke)\
**Post date:** [April 7, 2016, 12:13pm UTC](https://discuss.emberjs.com/t/emberjs-documentation-pages/7977/7 "2016-04-07T12:13:59Z")

</div>

Here’s an example of how I implement YUIDoc:

```auto
import Ember from 'ember';

/**
* The login controller shows the login form and sends authentication data to the session.
*
* @class login
* @namespace Controller
*/
export default Ember.Controller.extend({

  /**
  * The session service.
  *
  * @property session
  * @readOnly
  * @type Service
  */
  session: Ember.inject.service('session'),

  /**
  * The identification, usually an username or e-mailaddress.
  *
  * @property identification
  * @type String
  * @default null
  */
  identification: '',

  /**
  * The password.
  *
  * @property password
  * @type String
  * @default null
  */
  password: '',

  actions: {

    /**
    * The authenticate action sends the identification and password to the session.
    *
    * @event authenticate
    * @return undefined
    */
    authenticate() {
      this.get('session').authenticate('authenticator:jwt', this.getProperties('identification', 'password'));
    }

  }

});

```
