# Documentation Improvements

**URL:** <https://community.cesium.com/t/documentation-improvements/44>\
**Category:** CesiumJS\
**Created:** [June 29, 2012, 2:54pm UTC](https://community.cesium.com/t/documentation-improvements/44 "2012-06-29T14:54:49Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![Kristian\_Calhoun](https://avatars.discourse-cdn.com/v4/letter/k/67e7ee/32.png) [@Kristian\_Calhoun](https://community.cesium.com/u/Kristian_Calhoun)\
**Post date:** [June 29, 2012, 2:54pm UTC](https://community.cesium.com/t/documentation-improvements/44/1 "2012-06-29T14:54:49Z")

</div>

Hello everyone,

We’ve recently made some improvements and modifications to our documentation tool, resulting in more complete and usable reference documentation. If you are currently using Cesium, you may need to launch the clean target before building a new release or clear your browser’s cache for the new documentation to appear. Finally, as you continue to contribute to Cesium, please refer to our new [Documentation Best Practices](https://github.com/AnalyticalGraphicsInc/cesium/wiki/Documentation-Best-Practices) wiki as you document your code.

Thanks,

Kristian

---

<div class="post-metadata">

**Author:** ![patrick](https://sea2.discourse-cdn.com/cesium/user_avatar/community.cesium.com/patrick/32/2045_2.png) [@patrick](https://community.cesium.com/u/patrick)\
**Post date:** [June 29, 2012, 3:01pm UTC](https://community.cesium.com/t/documentation-improvements/44/2 "2012-06-29T15:01:08Z")

</div>

The full example still has DOC\_TBA and does not have an @example. 🙂

Patrick

---

<div class="post-metadata">

**Author:** ![Kristian\_Calhoun](https://avatars.discourse-cdn.com/v4/letter/k/67e7ee/32.png) [@Kristian\_Calhoun](https://community.cesium.com/u/Kristian_Calhoun)\
**Post date:** [June 29, 2012, 3:15pm UTC](https://community.cesium.com/t/documentation-improvements/44/3 "2012-06-29T15:15:25Z")

</div>

Duly noted and fixed. That’s what happens when one uses copy/paste. 😉

Several ` ` tags were also stripped out of the wiki’s example and are now HTML safe.

Kristian

---

<div class="post-metadata">

**Author:** ![patrick](https://sea2.discourse-cdn.com/cesium/user_avatar/community.cesium.com/patrick/32/2045_2.png) [@patrick](https://community.cesium.com/u/patrick)\
**Post date:** [June 29, 2012, 3:42pm UTC](https://community.cesium.com/t/documentation-improvements/44/4 "2012-06-29T15:42:30Z")

</div>

This best practices guide is a great start. A few comments for us all:

- Oracle’s [How to Write Doc Comments for the Javadoc Tool](http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html) guide has lots of good advice.
- Not all of our reference doc is up to par yet. If you are in code - even code you didn’t write - always feel free to improve the doc.
- As we learn more best practices, let’s update the wiki.

Patrick