# API documentation on GitHub

**URL:** https://forum.juce.com/t/api-documentation-on-github/15275
**Category:** General JUCE discussion
**Created:** [August 9, 2015, 2:36pm UTC](https://forum.juce.com/t/api-documentation-on-github/15275 "2015-08-09T14:36:29Z")
**Posts on this page:** 6
**Page:** 1

<div class="post-metadata">

### Author: ![GrokSynth](https://avatars.discourse-cdn.com/v4/letter/g/da6949/32.png) [@GrokSynth](https://forum.juce.com/u/GrokSynth)
#### Post date: [August 9, 2015, 2:36pm UTC](https://forum.juce.com/t/api-documentation-on-github/15275/1 "2015-08-09T14:36:29Z")

</div>

Most of the time (for convenience due to lack of an Internet connection), I have been using the offline version of the API documentation. &nbsp;Looking at GitHub today, I noticed that it appears to not have been updated for a while. &nbsp;

That is generally ok since I can just read the files themselves, but is it your intention to _not_ update this on GitHub in the future?

&nbsp;

---

<div class="post-metadata">

### Author: ![samuel](https://sea2.discourse-cdn.com/flex026/user_avatar/forum.juce.com/samuel/32/21_2.png) [@samuel](https://forum.juce.com/u/samuel)
#### Post date: [August 9, 2015, 3:23pm UTC](https://forum.juce.com/t/api-documentation-on-github/15275/2 "2015-08-09T15:23:00Z")

</div>

If you have installed doxygen via homebrew - like me -, slightly modify the run\_doxygen shell script from that repository.

Can't remeber if I also have modified the doxygen config file or not. On my 2011 Macbook it only takes a few seconds to build the documentation myself. -\> It's always up to date and it comes in my preferred colour scheme as well. ;)

---

<div class="post-metadata">

### Author: ![GrokSynth](https://avatars.discourse-cdn.com/v4/letter/g/da6949/32.png) [@GrokSynth](https://forum.juce.com/u/GrokSynth)
#### Post date: [August 9, 2015, 3:46pm UTC](https://forum.juce.com/t/api-documentation-on-github/15275/3 "2015-08-09T15:46:24Z")

</div>

Good idea. &nbsp;Thanks for pointing that out samuel. :)

---

<div class="post-metadata">

### Author: ![adamwilson](https://sea2.discourse-cdn.com/flex026/user_avatar/forum.juce.com/adamwilson/32/1387_2.png) [@adamwilson](https://forum.juce.com/u/adamwilson)
#### Post date: [August 9, 2015, 5:44pm UTC](https://forum.juce.com/t/api-documentation-on-github/15275/4 "2015-08-09T17:44:09Z")

</div>

Aha good call, thanks for the tip :)

---

<div class="post-metadata">

### Author: ![timur](https://sea2.discourse-cdn.com/flex026/user_avatar/forum.juce.com/timur/32/541_2.png) [@timur](https://forum.juce.com/u/timur)
#### Post date: [August 10, 2015, 2:39pm UTC](https://forum.juce.com/t/api-documentation-on-github/15275/5 "2015-08-10T14:39:28Z")

</div>

Yes, we won't maintain that GitHub documentation repository any longer. If you want the newest API reference, you have two possibilities:

1. use the online API reference on juce.com. Some people were not happy with the current black/orange colour scheme: yes, we heard you and there will be a redesign in the not-too-far future.

2. generate your own offline API reference.&nbsp; I just added the possibility to do so. If you update to the newest tip, you will find a new juce/doxygen subfolder with everything you need, like the Doxyfile. Please follow the instructions in juce/doxygen/README.txt.

---

<div class="post-metadata">

### Author: ![GrokSynth](https://avatars.discourse-cdn.com/v4/letter/g/da6949/32.png) [@GrokSynth](https://forum.juce.com/u/GrokSynth)
#### Post date: [November 1, 2015, 12:22pm UTC](https://forum.juce.com/t/api-documentation-on-github/15275/6 "2015-11-01T12:22:11Z")

</div>

Likely obvious note to MAC users - you need to make a symlink so you can call doxygen from the command line (and therefore follow the instructions in the JUCE repository) - - - -

sudo ln -s /Applications/Doxygen.app/Contents/Resources/doxygen /usr/local/bin
