[JEDI.NET-commits] docs Jedi.IO.Paths.xml,1.3,1.4
Status: Pre-Alpha
Brought to you by:
jedi_mbe
Menu
▾
▴
[JEDI.NET-commits] docs Jedi.IO.Paths.xml,1.3,1.4
|
From: Marcel B. <jed...@us...> - 2005-03-28 18:14:18
|
Update of /cvsroot/jedidotnet/docs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv13938/docs Modified Files: Jedi.IO.Paths.xml Log Message: * Updated missing docs for Combine method * Added docs for CommonBase, CommonBaseImpl, MakeRelativeFrom and PathElements Index: Jedi.IO.Paths.xml =================================================================== RCS file: /cvsroot/jedidotnet/docs/Jedi.IO.Paths.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** Jedi.IO.Paths.xml 8 Mar 2005 10:47:33 -0000 1.3 --- Jedi.IO.Paths.xml 28 Mar 2005 18:14:07 -0000 1.4 *************** *** 1,3 **** --- 1,4 ---- <?xml version="1.0" encoding="utf-8"?> + <!--Timestamp most recent auto generation: 2005-03-28 14:53:01 UTC--> <members> <member name="T:Jedi.IO.Path"> *************** *** 104,107 **** --- 105,109 ---- </summary> <param name="paths"> + The list of the paths to be combined. </param> <returns> *************** *** 139,142 **** --- 141,145 ---- </summary> <param name="paths"> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.Combine(System.String[])"]/param[@name="paths"]' /> </param> <param name="config"> *************** *** 172,175 **** --- 175,233 ---- </exception> </member> + <member name="M:Jedi.IO.Path.CommonBase(System.String,System.String)"> + <overloads> + Determines the common base path of two or more paths. + </overloads> + <summary> + Determines the common base path of two paths. + </summary> + <param name="path1"> + The first path. + </param> + <param name="path2"> + The second path. + </param> + <returns> + A <see cref="T:System.String" /> representing the base path that both paths have in common. This can be an + <see cref="F:System.String.Empty">empty string</see> if the paths have no common base. + </returns> + </member> + <member name="M:Jedi.IO.Path.CommonBase(System.String,System.String,Jedi.IO.Path.PathConfig)"> + <summary> + Determines the common base path of two paths, using a specific path configuration. + </summary> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.CommonBase(System.String,System.String)"]/param[@name="path1"]' /> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.CommonBase(System.String,System.String)"]/param[@name="path2"]' /> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.Combine(System.String,System.String,Jedi.IO.Path.PathConfig)"]/param[@name="config"]' /> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.CommonBase(System.String,System.String)"]/returns' /> + </member> + <member name="M:Jedi.IO.Path.CommonBase(System.String[])"> + <summary> + Determines the common base path of two or more paths. + </summary> + <param name="paths"> + The list of paths to detemine the common path of. + </param> + <returns> + A <see cref="T:System.String" /> representing the base path that all paths have in common. This can be an + <see cref="F:System.String.Empty">empty string</see> if the paths have no common base. + </returns> + </member> + <member name="M:Jedi.IO.Path.CommonBase(System.String[],Jedi.IO.Path.PathConfig)"> + <summary> + Determines the common base path of two or more paths, using a specific path configuration. + </summary> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.CommonBase(System.String[])"]/param[@name="paths"]' /> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.Combine(System.String,System.String,Jedi.IO.Path.PathConfig)"]/param[@name="config"]' /> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.CommonBase(System.String[])"]/returns' /> + </member> + <member name="M:Jedi.IO.Path.CommonBaseImpl(System.String[],Jedi.IO.Path.PathConfig)"> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.CommonBase(System.String[])"]/summary' /> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.CommonBase(System.String[])"]/param[@name="paths"]' /> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.Combine(System.String,System.String,Jedi.IO.Path.PathConfig)"]/param[@name="config"]' /> + <returns> + An <see cref="T:System.Collections.ArrayList" /> containing the individual path elements that all paths have in common. + </returns> + </member> <member name="M:Jedi.IO.Path.EnsureEndingDirectorySeparator(System.String)"> <summary> *************** *** 345,348 **** --- 403,433 ---- </returns> </member> + <member name="M:Jedi.IO.Path.MakeRelativeFrom(System.String,System.String)"> + <overloads> + Determines the relative path from a base path to a given path. + </overloads> + <summary> + Determines the relative path from a base path to a given path. + </summary> + <param name="inPath"> + The path to make relative. + </param> + <param name="basePath"> + The path from which <paramref name="inPath" /> should be made relative from. + </param> + <returns> + A <see cref="T:System.String" /> equivalent to the path specified in the <paramref name="inPath" /> parameter, but + relative to the path specified by the <paramref name="basePath" /> parameter. + </returns> + </member> + <member name="M:Jedi.IO.Path.MakeRelativeFrom(System.String,System.String,Jedi.IO.Path.PathConfig)"> + <summary> + Determines the relative path from a base path to a given path using a specific configuration. + </summary> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.MakeRelativeFrom(System.String,System.String)"]/param[@name="inPath"]' /> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.MakeRelativeFrom(System.String,System.String)"]/param[@name="basePath"]' /> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.Combine(System.String,System.String,Jedi.IO.Path.PathConfig)"]/param[@name="config"]' /> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.MakeRelativeFrom(System.String,System.String)"]/returns' /> + </member> <member name="M:Jedi.IO.Path.Normalize(System.String)"> <overloads> *************** *** 494,497 **** --- 579,612 ---- </returns> </member> + <member name="M:Jedi.IO.Path.PathElements(System.String)"> + <overloads> + Returns a list of path elements. + </overloads> + <summary> + Returns a list of path elements. + </summary> + <param name="path"> + The path to retrieve the individual volume, directories and file elements from. + </param> + <returns> + An <see cref="T:System.Array">array</see> of <see cref="T:System.String" /> with each element being either a + volume, directory or file. + </returns> + <remarks> + The given path is first normalized after which the resulting path string is split at the + <see cref="M:Jedi.IO.Path.PathConfig.DirectorySeparator" /> character. This method is functionally equivalent to a + call to the <see cref="M:Jedi.IO.Path.Normalize(System.String,Jedi.IO.Path.PathConfig)" /> and then calling + <see cref="T:System.String.Split(System.Char[])" />. + </remarks> + </member> + <member name="M:Jedi.IO.Path.PathElements(System.String,Jedi.IO.Path.PathConfig)"> + <summary> + Returns a list of path elements using a specific path configuration. + </summary> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.PathElements(System.String)"]/param[@name="path"]' /> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.Combine(System.String,System.String,Jedi.IO.Path.PathConfig)"]/param[@name="config"]' /> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.PathElements(System.String)"]/returns' /> + <include file='Jedi.IO.Paths.xml' path='/members/member[@name="M:Jedi.IO.Path.PathElements(System.String)"]/remarks' /> + </member> <member name="F:Jedi.IO.Path.SysConfig"> <exclude /> |
