FS#48134 - [gnuradio] add gui documentation (patch)

Attached to Project: Community Packages
Opened by Stanislaw Pitucha (viraptor) - Thursday, 11 February 2016, 01:30 GMT
Last edited by Toolybird (Toolybird) - Saturday, 01 April 2023, 01:03 GMT
Task Type Feature Request
Category Packages
Status Closed
Assigned To Kyle Keen (keenerd)
Architecture All
Severity Low
Priority Normal
Reported Version
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 1
Private No

Details

Add documentation building to gnuradio. This patch does two things:
- create a new -docs package with files generated by doxygen (>100MB)
- add short documentation and better tooltips to the modules in companion gui (does not require -docs installed)
   gnuradio_docs.patch (2.6 KiB)
This task depends upon

Closed by  Toolybird (Toolybird)
Saturday, 01 April 2023, 01:03 GMT
Reason for closing:  No response
Comment by Kyle Keen (keenerd) - Thursday, 11 February 2016, 02:32 GMT
Would these be the same docs as https://gnuradio.org/doc/doxygen/ ?

It is a bit old fashioned of me, but I generally don't like packaging that sort of stuff. What is the rational for having it?
Comment by Stanislaw Pitucha (viraptor) - Thursday, 11 February 2016, 02:50 GMT
In the -docs package - yes. But that's really a side effect of what I really wanted to achieve which is the second point - in app documentation. (see the attached screenshots)

If you don't like the -docs package, you can drop it, but the included files have to be generated during the build anyway to extract the in-app help. I thought they may as well be packaged then.
   no_doc.png (13.6 KiB)
   with_doc.png (40.7 KiB)
Comment by Roberto Nobrega (Liquen) - Saturday, 19 August 2017, 22:51 GMT
Could you please consider adding the patch? Having the documentation inside gnuradio-companion would be really handy.
Comment by David Runge (dvzrv) - Saturday, 14 January 2023, 17:11 GMT
Is this still relevant in the current version (3.10.5.0)?

Loading...