diff --git a/Doxyfile b/Doxyfile index a8a3e16..1bb2af3 100644 --- a/Doxyfile +++ b/Doxyfile @@ -486,7 +486,7 @@ SHOW_DIRECTORIES = NO # This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. -SHOW_FILES = YES +SHOW_FILES = NO # Set the SHOW_NAMESPACES tag to NO to disable the generation of the # Namespaces page. @@ -721,7 +721,7 @@ REFERENCES_RELATION = NO # link to the source code. # Otherwise they will link to the documentation. -REFERENCES_LINK_SOURCE = YES +REFERENCES_LINK_SOURCE = NO # If the USE_HTAGS tag is set to YES then the references to source code # will point to the HTML generated by the htags(1) tool instead of doxygen @@ -735,7 +735,7 @@ USE_HTAGS = NO # will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. -VERBATIM_HEADERS = YES +VERBATIM_HEADERS = NO #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index diff --git a/RF24.h b/RF24.h index 1940f56..308232c 100644 --- a/RF24.h +++ b/RF24.h @@ -138,7 +138,7 @@ protected: /** * Decode and print the given 'observe_tx' value to stdout * - * @param Value The observe_tx value to print + * @param value The observe_tx value to print * * @warning Does nothing if stdout is not defined. See fdevopen in stdio.h */ @@ -149,6 +149,9 @@ protected: public: /** * Constructor + * + * Creates a new instance of this driver. Before using, you create an instance + * and send in the unique pins that this chip is connected to. * * @param _cepin The pin attached to Chip Enable on the RF module * @param _cspin The pin attached to Chip Select @@ -258,11 +261,12 @@ public: * Remember to stopListening() first. * * Addresses are 40-bit hex values, e.g.: + * * @code * openWritingPipe(0xF0F0F0F0F0); * @endcode * - * @param value The 40-bit address of the pipe to open. This can be + * @param address The 40-bit address of the pipe to open. This can be * any value whatsoever, as long as you are the only one writing to it * and only one other radio is listening to it. Coordinate these pipe * addresses amongst nodes on the network. @@ -279,6 +283,7 @@ public: * * @warning all 5 reading pipes should share the first 32 bits. * Only the least significant byte should be unique, e.g. + * * @code * openReadingPipe(0xF0F0F0F0AA); * openReadingPipe(0xF0F0F0F066);