[JEDI.NET-commits] docs Jedi.IO.IniFiles.xml,1.6,1.7

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/jedidotnet/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv14345/docs

Modified Files:
	Jedi.IO.IniFiles.xml 
Log Message:
Documented the BufferedIniFile class

Index: Jedi.IO.IniFiles.xml
===================================================================
RCS file: /cvsroot/jedidotnet/docs/Jedi.IO.IniFiles.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** Jedi.IO.IniFiles.xml	13 Mar 2005 19:39:44 -0000	1.6
--- Jedi.IO.IniFiles.xml	13 Mar 2005 20:25:57 -0000	1.7
***************
*** 4,23 ****
    <member name="T:Jedi.IO.BufferedIniFile">
      <summary>
      </summary>
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.#ctor(System.String)">
      <summary>
      </summary>
      <param name="path">
      </param>
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.#ctor(System.String,System.Int32,System.Int32)">
      <summary>
      </summary>
!     <param name="path">
!     </param>
      <param name="autoReloadInterval">
      </param>
      <param name="autoFlushInterval">
      </param>
    </member>
--- 4,51 ----
    <member name="T:Jedi.IO.BufferedIniFile">
      <summary>
+       Represents a configuration file on disk buffered in memory.
      </summary>
+     <remarks>
+       <para>
+         The file specified by the constructor will be loaded in memory and remains there until this object is disposed.
+         Any data written to the configuration file will remain in memory only (and can thus be reverted by forcing a
+         <see cref="M:Jedi.IO.BufferedIniFile.FullReload">reload</see> of the physical file.
+       </para>
+       <para>
+         In addition to writing changes back to disk when the object is disposed or
+         <see cref="M:Jedi.IO.BufferedIniFile.Flush">explicitly instructed</see> to do so, the class provides a mechanism
+         to automatically write changes to disk at a <see cref="P:Jedi.IO.BufferedIniFile.AutoFlushInterval">set
+         interval</see>.
+       </para>
+       <para>
+         A similar mechanism is provided to automatically merge changes made to the physical file on disk outside of this
+         instance at a <see cref="AutoReloadInterval">set interval</see>. This mechanism allows several instances to work
+         with the same physical file, even in different application, at the same time. If an item is changed in both the
+         buffered copy as well as the disk, the changes in memory will remain active.
+       </para>
+     </remarks>
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.#ctor(System.String)">
+     <overloads>
+       Initializes a new instance of the <see cref="T:Jedi.IO.BufferedIniFile" /> class.
+     </overloads>
      <summary>
+       Initializes a new instance of the <see cref="T:Jedi.IO.BufferedIniFile" /> class.
      </summary>
      <param name="path">
+       The filename of the file to open.
      </param>
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.#ctor(System.String,System.Int32,System.Int32)">
      <summary>
+       Initializes a new instance of the <see cref="T:Jedi.IO.BufferedIniFile" /> class, specifying the automatic flush
+       and reload intervals.
      </summary>
!     <include file='Jedi.IO.IniFiles.xml' path='members/member[@name="M:Jedi.IO.BufferedIniFile.#ctor(System.String)"]/param[@name="path"]' />
      <param name="autoReloadInterval">
+       Interval in milliseconds between automatic merging of changes made outside of this instance to the physical file.
      </param>
      <param name="autoFlushInterval">
+       Interval in milliseconds between automatically writing changes back to the physical file.
      </param>
    </member>
***************
*** 27,50 ****
    <member name="M:Jedi.IO.BufferedIniFile.AutoFlushHandler(Jedi.Timers.ScheduledEvent)">
      <summary>
      </summary>
      <param name="event">
      </param>
    </member>
    <member name="P:Jedi.IO.BufferedIniFile.AutoFlushInterval">
      <summary>
      </summary>
      <value>
      </value>
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.AutoReloadHandler(Jedi.Timers.ScheduledEvent)">
      <summary>
      </summary>
!     <param name="event">
!     </param>
    </member>
    <member name="P:Jedi.IO.BufferedIniFile.AutoReloadInterval">
      <summary>
      </summary>
      <value>
      </value>
    </member>
--- 55,100 ----
    <member name="M:Jedi.IO.BufferedIniFile.AutoFlushHandler(Jedi.Timers.ScheduledEvent)">
      <summary>
+       The event handler called to check if changes should be written to disk.
      </summary>
      <param name="event">
+       The <see cref="T:Jedi.Timers.ScheduledEvent" /> instance that raised the event.
      </param>
    </member>
    <member name="P:Jedi.IO.BufferedIniFile.AutoFlushInterval">
      <summary>
+       Gets or sets the interval in milliseconds between automatic flushing of changes to disk.
      </summary>
      <value>
+       <para>
+         The interval in milliseconds between automatic flushing of changes to disk.
+       </para>
+       <para>
+         -or-
+       </para>
+       <para>
+         0 (zero) to disable automatic flushing of changes.
+       </para>
      </value>
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.AutoReloadHandler(Jedi.Timers.ScheduledEvent)">
      <summary>
+       The event handler called to check if outside changes should be merged from disk.
      </summary>
!     <include file='Jedi.IO.IniFiles.xml' path='members/member[@name="M:Jedi.IO.BufferedIniFile.AutoFlushHandler(Jedi.Timers.ScheduledEvent)"]/param[@name="event"]' />
    </member>
    <member name="P:Jedi.IO.BufferedIniFile.AutoReloadInterval">
      <summary>
+       Gets or sets the interval in milliseconds between automatic merging of changes from disk.
      </summary>
      <value>
+       <para>
+         The interval in milliseconds between automatic merging of changes from disk.
+       </para>
+       <para>
+         -or-
+       </para>
+       <para>
+         0 (zero) to disable automatic merging of changes.
+       </para>
      </value>
    </member>
***************
*** 59,64 ****
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.Dispose">
!     <summary>
!     </summary>
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.Finalize">
--- 109,113 ----
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.Dispose">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.Finalize">
***************
*** 67,78 ****
--- 116,130 ----
    <member name="M:Jedi.IO.BufferedIniFile.Flush">
      <summary>
+       Writes pending changes from memory to the physical file on disk.
      </summary>
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.FlushImpl">
      <summary>
+       Writes the image in memory to the physical file on disk.
      </summary>
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.FullReload">
      <summary>
+       Reloads the physical file, discarding any pending changes still in memory.
      </summary>
    </member>
***************
*** 87,104 ****
    </member>
    <member name="T:Jedi.IO.BufferedIniFile.IniFileEnumerator">
!     <summary>
!     </summary>
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.IniFileEnumerator.#ctor(Jedi.IO.IniFileBase,System.Int32,System.Int32,System.String)">
!     <summary>
!     </summary>
!     <param name="IniFile">
!     </param>
!     <param name="iterationType">
!     </param>
!     <param name="returnType">
!     </param>
!     <param name="section">
!     </param>
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.IniFileEnumerator.KeyImpl">
--- 139,146 ----
    </member>
    <member name="T:Jedi.IO.BufferedIniFile.IniFileEnumerator">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.IniFileEnumerator.#ctor(Jedi.IO.IniFileBase,System.Int32,System.Int32,System.String)">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.IniFileEnumerator.KeyImpl">
***************
*** 119,130 ****
--- 161,178 ----
    <member name="M:Jedi.IO.BufferedIniFile.NeedFlush">
      <summary>
+       Determines if there are changes in the memory buffer that haven't been written to disk yet.
      </summary>
      <returns>
+       <see langword="true" /> if the memory buffer has changes that are not yet written to disk; otherwise,
+       <see cref="false" />.
      </returns>
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.NeedReload">
      <summary>
+       Determines if the file on disk has changed since the last load or flush.
      </summary>
      <returns>
+       <see langword="true" /> if the physical file on disk has changed since the last time it was read or updated by
+       this instance; otherwise, <see cref="false" />.
      </returns>
    </member>
***************
*** 134,151 ****
--- 182,207 ----
    <member name="M:Jedi.IO.BufferedIniFile.Reload">
      <overloads>
+       Reloads the physical file from disk.
      </overloads>
      <summary>
+       Reloads the physical file from disk, letting changes still in memory override the changes on disk.
      </summary>
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.Reload(System.Boolean)">
      <summary>
+       Reloads the physical file from disk specifying whether it will override changes in memory.
      </summary>
      <param name="fileOverridesChanges">
+       <see langword="true" /> if changes on disk will override the changes in memory; otherwise
+       <see langword="false" />.
      </param>
    </member>
    <member name="M:Jedi.IO.BufferedIniFile.ReloadImpl(System.Boolean)">
      <summary>
+       Reloads the physical file from disk specifying whether it will override changes in memory.
      </summary>
      <param name="fileOverridesChanges">
+       <see langword="true" /> if changes on disk will override the changes in memory; otherwise
+       <see langword="false" />.
      </param>
    </member>
***************
*** 1626,1647 ****
    </member>
    <member name="T:Jedi.IO.MemoryIniFileBase.IniFileEnumerator">
!     <summary>
!     </summary>
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.IniFileEnumerator.#ctor(Jedi.IO.IniFileBase,System.Int32,System.Int32,System.String)">
!     <summary>
!     </summary>
!     <param name="IniFile">
!     </param>
!     <param name="iterationType">
!     </param>
!     <param name="returnType">
!     </param>
!     <param name="section">
!     </param>
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.IniFileEnumerator.KeyEnum">
!     <summary>
!     </summary>
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.IniFileEnumerator.KeyImpl">
--- 1682,1692 ----
    </member>
    <member name="T:Jedi.IO.MemoryIniFileBase.IniFileEnumerator">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.IniFileEnumerator.#ctor(Jedi.IO.IniFileBase,System.Int32,System.Int32,System.String)">
!     <exclude />
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.IniFileEnumerator.KeyEnum">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.IniFileEnumerator.KeyImpl">
***************
*** 1655,1660 ****
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.IniFileEnumerator.SectEnum">
!     <summary>
!     </summary>
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.IniFileEnumerator.SectionImpl">
--- 1700,1704 ----
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.IniFileEnumerator.SectEnum">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.IniFileEnumerator.SectionImpl">
***************
*** 1677,1690 ****
    </member>
    <member name="T:Jedi.IO.MemoryIniFileBase.KeyOrValueList">
!     <summary>
!     </summary>
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyOrValueList.#ctor(Jedi.IO.MemoryIniFileBase.KeyValueDictionary,System.Boolean)">
!     <summary>
!     </summary>
!     <param name="KeyValueDictionary">
!     </param>
!     <param name="isKeyList">
!     </param>
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyOrValueList.Add(System.Object)">
--- 1721,1728 ----
    </member>
    <member name="T:Jedi.IO.MemoryIniFileBase.KeyOrValueList">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyOrValueList.#ctor(Jedi.IO.MemoryIniFileBase.KeyValueDictionary,System.Boolean)">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyOrValueList.Add(System.Object)">
***************
*** 1737,1764 ****
    </member>
    <member name="T:Jedi.IO.MemoryIniFileBase.KeyValueDictionary">
!     <summary>
!     </summary>
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.#ctor">
!     <summary>
!     </summary>
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.#ctor(Jedi.IO.MemoryIniFileBase,System.Int32)">
!     <summary>
!     </summary>
!     <param name="IniFile">
!     </param>
!     <param name="keyType">
!     </param>
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.#ctor(Jedi.IO.MemoryIniFileBase,System.Int32,System.String)">
!     <summary>
!     </summary>
!     <param name="IniFile">
!     </param>
!     <param name="keyType">
!     </param>
!     <param name="restrictToSection">
!     </param>
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.Add(System.Object,System.Object)">
--- 1775,1788 ----
    </member>
    <member name="T:Jedi.IO.MemoryIniFileBase.KeyValueDictionary">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.#ctor">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.#ctor(Jedi.IO.MemoryIniFileBase,System.Int32)">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.#ctor(Jedi.IO.MemoryIniFileBase,System.Int32,System.String)">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.Add(System.Object,System.Object)">
***************
*** 1814,1831 ****
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.IniFile">
!     <summary>
!     </summary>
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.KeyType">
!     <summary>
!     </summary>
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.KeyTypeKeyOnly">
!     <summary>
!     </summary>
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.KeyTypeSectAndKey">
!     <summary>
!     </summary>
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.Remove(System.Object)">
--- 1838,1851 ----
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.IniFile">
!     <exclude />
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.KeyType">
!     <exclude />
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.KeyTypeKeyOnly">
!     <exclude />
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.KeyTypeSectAndKey">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.Remove(System.Object)">
***************
*** 1833,1838 ****
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.RestrictToSection">
!     <summary>
!     </summary>
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.set_Item(System.Object,System.Object)">
--- 1853,1857 ----
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.RestrictToSection">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.set_Item(System.Object,System.Object)">
***************
*** 1840,1865 ****
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.UpdateInfo">
!     <summary>
!     </summary>
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.UpdateVersion">
!     <summary>
!     </summary>
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.Version">
!     <summary>
!     </summary>
    </member>
    <member name="T:Jedi.IO.MemoryIniFileBase.KeyValueEnumerator">
!     <summary>
!     </summary>
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueEnumerator.#ctor(Jedi.IO.MemoryIniFileBase.KeyValueDictionary,System.Int32)">
!     <summary>
!     </summary>
!     <param name="keyValueDictionary">
!     </param>
!     <param name="returnType">
!     </param>
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueEnumerator.get_Current">
--- 1859,1875 ----
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.UpdateInfo">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.UpdateVersion">
!     <exclude />
    </member>
    <member name="F:Jedi.IO.MemoryIniFileBase.KeyValueDictionary.Version">
!     <exclude />
    </member>
    <member name="T:Jedi.IO.MemoryIniFileBase.KeyValueEnumerator">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueEnumerator.#ctor(Jedi.IO.MemoryIniFileBase.KeyValueDictionary,System.Int32)">
!     <exclude />
    </member>
    <member name="M:Jedi.IO.MemoryIniFileBase.KeyValueEnumerator.get_Current">