https://esden.net This is Piotr Esden-Tempski's personal blog Zola en Thu, 19 Aug 2010 00:00:00 +0000 Thu, 19 Aug 2010 00:00:00 +0000 Esden https://esden.net/blog/2010-08-19-open-bldc-documentation/ https://esden.net/blog/2010-08-19-open-bldc-documentation/ <p><a rel="noopener external" target="_blank" href="http://esden.net/wp-content/uploads/2010/08/open-bldc-doxygen-screenshot.png"><img src="https://esden.net/blog/2010-08-19-open-bldc-documentation/images/open-bldc-doxygen-screenshot-300x287.png" alt="" title="open-bldc-doxygen-screenshot" /></a></p> <p>Today was a big documentation day for <a rel="noopener external" target="_blank" href="http://open-bldc.org">Open-BLDC</a>.</p> <p>As <a rel="noopener external" target="_blank" href="http://github.com/fuchsto">Tobi</a> is learning about Open-BLDC to be able to help me with development I really felt the lack of documentation. So together with him we wrote down how the <a rel="noopener external" target="_blank" href="http://open-bldc.org/wiki/Ignition_Strategies">ignition system</a> currently works. Also I added a <a rel="noopener external" target="_blank" href="http://open-bldc.org/wiki/Developer_getting_started">getting started</a> page describing how to build the firmware.</p> <p>Last but not least (that took me most of yesterday) I finally managed to add doxygen generation to the firmware code. It is even being automatically generated out of the git repository and making it available on http://doc.open-bldc.org.</p> <p>There is still a lot that can be told about the system, but I think we are on the right path. The documentation should grow now significantly when I am not the only person working on the code. :)</p>