# LMS API Documentation - Where is it?

**URL:** <https://discourse.myriadrf.org/t/lms-api-documentation-where-is-it/7417>\
**Category:** Lime Suite\
**Created:** [17 November 2021 12:35 UTC](https://discourse.myriadrf.org/t/lms-api-documentation-where-is-it/7417 "2021-11-17T12:35:32Z")\
**Posts on this page:** 7\
**Page:** 1

<div class="post-metadata">

**Author:** ![DaveG8GKQ](https://yyz2.discourse-cdn.com/flex034/user_avatar/discourse.myriadrf.org/daveg8gkq/32/2361_2.png) [@DaveG8GKQ](https://discourse.myriadrf.org/u/DaveG8GKQ)\
**Post date:** [17 November 2021 12:35 UTC](https://discourse.myriadrf.org/t/lms-api-documentation-where-is-it/7417/1 "2021-11-17T12:35:33Z")

</div>

I used to use the LMS API documentation at [https://docs.myriadrf.org/LMS\_API/index.html](https://docs.myriadrf.org/LMS_API/index.html). Even though it might not have been absolutely up-to-date, it was a very useful resource.

I see that it has been taken down and there was an intention stated in August 2021 to replace it. Where can I find the replacement?

Thanks

Dave, G8GKQ

---

<div class="post-metadata">

**Author:** ![yt7pwr](https://avatars.discourse-cdn.com/v4/letter/y/ecd19e/32.png) [@yt7pwr](https://discourse.myriadrf.org/u/yt7pwr)\
**Post date:** [17 November 2021 13:02 UTC](https://discourse.myriadrf.org/t/lms-api-documentation-where-is-it/7417/2 "2021-11-17T13:02:22Z")

</div>

Main header file for exported API functions:

> <https://github.com/myriadrf/LimeSuite/blob/master/src/lime/LimeSuite.h>

73, Goran yt7pwr

---

<div class="post-metadata">

**Author:** ![DaveG8GKQ](https://yyz2.discourse-cdn.com/flex034/user_avatar/discourse.myriadrf.org/daveg8gkq/32/2361_2.png) [@DaveG8GKQ](https://discourse.myriadrf.org/u/DaveG8GKQ)\
**Post date:** [17 November 2021 13:04 UTC](https://discourse.myriadrf.org/t/lms-api-documentation-where-is-it/7417/3 "2021-11-17T13:04:27Z")

</div>

Thanks Goran!

Not as easy to read as the old format, but at least I can now find the information that I want.

73

Dave, G8GKQ

---

<div class="post-metadata">

**Author:** ![mzs](https://yyz2.discourse-cdn.com/flex034/user_avatar/discourse.myriadrf.org/mzs/32/2678_2.png) [@mzs](https://discourse.myriadrf.org/u/mzs)\
**Post date:** [17 November 2021 14:35 UTC](https://discourse.myriadrf.org/t/lms-api-documentation-where-is-it/7417/4 "2021-11-17T14:35:33Z")

</div>

Use [doxygen](https://www.doxygen.org/index.html) to generate documentation from annotated source files.

---

<div class="post-metadata">

**Author:** ![andrewback](https://avatars.discourse-cdn.com/v4/letter/a/22d042/32.png) [@andrewback](https://discourse.myriadrf.org/u/andrewback)\
**Post date:** [17 November 2021 16:32 UTC](https://discourse.myriadrf.org/t/lms-api-documentation-where-is-it/7417/5 "2021-11-17T16:32:48Z")

</div>

@DaveG8GKQ working on an improved replacement, which will be automatically updated, but got sidetracked by a number of other things and so this isn’t completed yet. As @mzs notes, you can also just build Lime Suite with Doxygen installed and then you have a copy of the same docs locally.

---

<div class="post-metadata">

**Author:** ![DaveG8GKQ](https://yyz2.discourse-cdn.com/flex034/user_avatar/discourse.myriadrf.org/daveg8gkq/32/2361_2.png) [@DaveG8GKQ](https://discourse.myriadrf.org/u/DaveG8GKQ)\
**Post date:** [17 November 2021 16:48 UTC](https://discourse.myriadrf.org/t/lms-api-documentation-where-is-it/7417/6 "2021-11-17T16:48:04Z")

</div>

Thanks @andrewback

Time for me to learn about Doxygen! I’ve never had the need to use it before - not sure what that says about my software development processes…

Dave

---

<div class="post-metadata">

**Author:** ![andrewback](https://avatars.discourse-cdn.com/v4/letter/a/22d042/32.png) [@andrewback](https://discourse.myriadrf.org/u/andrewback)\
**Post date:** [17 November 2021 18:08 UTC](https://discourse.myriadrf.org/t/lms-api-documentation-where-is-it/7417/7 "2021-11-17T18:08:29Z")

</div>

I think you should just need to have Doxygen installed when you run cmake, then it will find this and configure the build appropriately and generate HTML output.