LMS API Documentation - Where is it?

DaveG8GKQ · 17 November 2021 12:35

I used to use the LMS API documentation at 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

yt7pwr · 17 November 2021 13:02

Main header file for exported API functions:

github.com

myriadrf/LimeSuite/blob/master/src/lime/LimeSuite.h

/**
 * @file lime/LimeSuite.h
 *
 * @brief LMS API library
 *
 * Copyright (C) 2016 Lime Microsystems
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

This file has been truncated. show original

73, Goran yt7pwr

DaveG8GKQ · 17 November 2021 13:04

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

mzs · 17 November 2021 14:35

Use doxygen to generate documentation from annotated source files.

andrewback · 17 November 2021 16:32

@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.

DaveG8GKQ · 17 November 2021 16:48

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

andrewback · 17 November 2021 18:08

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.