Răsfoiți Sursa

Adds doxygen docu and consts parameter

Martin Melik Merkumians 9 ani în urmă
părinte
comite
9c355affde
2 a modificat fișierele cu 7 adăugiri și 3 ștergeri
  1. 1 1
      source/src/cip/cipelectronickey.c
  2. 6 2
      source/src/cip/cipelectronickey.h

+ 1 - 1
source/src/cip/cipelectronickey.c

@@ -61,7 +61,7 @@ CipUint ElectronicKeyFormat4GetProductCode(
 }
 
 void ElectronicKeyFormat4SetMajorRevisionCompatibility(
-  CipByte major_revision_compatibility,
+  const CipByte major_revision_compatibility,
   ElectronicKeyFormat4 *const electronic_key) {
   electronic_key->major_revision_compatibility = major_revision_compatibility;
 }

+ 6 - 2
source/src/cip/cipelectronickey.h

@@ -79,10 +79,14 @@ void ElectronicKeyFormat4SetProductCode(const CipUint product_code,
 CipUint ElectronicKeyFormat4GetProductCode(
   const ElectronicKeyFormat4 *const electronic_key);
 
+/** @brief Sets the major revision byte including the compatibility flag
+ *
+ *      @param major_revision_compatibility The major revision byte including the compatibility flag
+ *      @param electronic_key The electronic key to be modified
+ */
 void ElectronicKeyFormat4SetMajorRevisionCompatibility(
-  CipByte major_revision_compatibility,
+  const CipByte major_revision_compatibility,
   ElectronicKeyFormat4 *const electronic_key);
-//CipByte GetElectronicKeyFormat4MajorRevisionCompatibility(const ElectronicKeyFormat4 *const electronic_key);
 
 /** @brief Gets the major revision from an format 4 electronic key
  *