linux/ipcore/PapbVcInterface.h

@@ -35,18 +35,13 @@ class PapbVcInterface : public VirtualChannelIF {
                   size_t maxPacketSize);
   virtual ~PapbVcInterface();
 
+  // See interface function documentation for docs on these functions.
+
   bool isBusy() const override;
-  /**
-   *
-   * @param data
-   * @param size
-   * @return returnvalue::OK on successfull write, PAPB_BUSY if PAPB is busy.
-   */
+
   ReturnValue_t write(const uint8_t* data, size_t size, size_t& writtenSize) override;
 
   ReturnValue_t advanceWrite(size_t& remainingSize) override;
-  //  ReturnValue_t finishWriteInternal(const uint8_t* data, size_t start, size_t remainingSize,
-  //                                    size_t& writtenSize, bool abortOnPartialWrite);
 
   void cancelTransfer() override;
 

mission/tmtc/DirectTmSinkIF.h

@@ -37,9 +37,15 @@ class DirectTmSinkIF {
    * @param writtenSize
    * @return returnvalue::OK if the packet write process is complete, PARTIALLY_WRITTEN if
    *    some bytes were written but the transfer is not complete yet.
+   *    NO_WRITE_ACTIVE if this is called without a valid previous write call.
    */
   virtual ReturnValue_t advanceWrite(size_t& writtenSize) = 0;
 
+  /**
+   * Is busy, so no write operation can not be started and write advancement
+   * is not possible.
+   * @return
+   */
   virtual bool isBusy() const = 0;
   /**
    * The PAPB interface is currently busy writing a packet and a new packet can not be written yet.