Re: [Discuss-gnuradio] gr-lte api

[Marcus Müller]

Hi Daniel,

well, when you build gr-lte, it also builds the same "kind" of documentation, the doxygen API reference.

However, the single blocks aren't necessarily as well-documented. But: Johannes did a really nice job of commenting his code, so I can only encourage you to read the source code, and take notes – and if I may have a wish, take these notes in the shape of doxygen comments in the gr-lte/include/lte/*.h header files, so that they are integrated in the API documentation. Then, make a Pull Request, and get famous for being the one that helped document gr-lte!

Best regards,

Marcus

On 09.09.2017 05:24, w xd wrote:

Hello guys,

Does the gr-lte have the api like gnuradio(for example https://gnuradio.org/doc/doxygen/classgr_1_1digital_1_1ofdm__carrier__allocator__cvc.html)? Gnuradio api has the detail description about every modules which can help us to understand it.

Although the documents like the thesis provided by the github/gr-lte are very nice, I think the more detail description about every modules is very necessary.  

Have someone seen the api of gr-lte? Or some other documents which can help us ?

Thanks very much. 

Regards,

daniel

_______________________________________________
Discuss-gnuradio mailing list
address@hidden
https://lists.gnu.org/mailman/listinfo/discuss-gnuradio