Editing User vs Developer Documentation

Jump to: navigation, search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 13: Line 13:
 
* In this context, developers are those who are modifying GR source code, or just software-dev-oriented folks who take the time to read through code
 
* In this context, developers are those who are modifying GR source code, or just software-dev-oriented folks who take the time to read through code
 
* If they are reading through a block's code, they probably know how the block works at a high level, but are interested in programmatic details
 
* If they are reading through a block's code, they probably know how the block works at a high level, but are interested in programmatic details
* Mostly (or only?) consists of documentation is that in-line with the code
+
* Mostly consists of documentation is that in-line with the code
 
* Can be viewed in the Doxygen manual or just directly while viewing code
 
* Can be viewed in the Doxygen manual or just directly while viewing code
 
* The developer documentation is going to be much more code-oriented, and involve more details about the implementation of the block (i.e. the block's API)
 
* The developer documentation is going to be much more code-oriented, and involve more details about the implementation of the block (i.e. the block's API)

Please note that all contributions to GNU Radio are considered to be released under the Creative Commons Attribution-ShareAlike (see GNU Radio:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)