[Quickfix-developers] can I submit documentation to included in the source code?

[Clark l. <cga...@gm...>]

I am going through the code which handles session messages line by line, and
writing documentation for my own use.
For example I just wrote this for the FIX::SessionState::reset()   function


/**

     <b> Assumes: </b> That the child class of MessageStore, which is
pointed to by m_pStore, has an appropriatly programmed logic
<br/>
     <b> Changes </b> nextSenderMsgSeqNum, nextTargetMsgSeqNum, all message
caches and time stamps representing the beginning of a FIX
Session<br/>
     <b> Error Behavior:</b> If there is an io orror, which prevents the
message store from being reset, than an exception of
type
           IOException is
thrown<br/>

     <b> Description: </b> This virtual function resets all relevent data to
represent the beginning of a FIX
session.

<ul>

     <li>  nextSenderMsgSeqNum is set to 1
</li>

     <li>  nextTargetMsgSeqNum is set to  1
</li>

     <li>  any message caches are emptied
</li>

     <li>  timestamps representing the start of the session are set to the
current time
</li>

</ul>

     The function FIX::memory_store::reset() provides a good illustration of
this
behavior.
   */

Can I submit this documentation so it can be included in future releases of
the code and documentation?