You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

798 lines
54 KiB

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Hive.Versioning</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Hive.Versioning.Version">
  8. <summary>
  9. A version that meets the Semantic Versioning specification.
  10. </summary>
  11. </member>
  12. <member name="P:Hive.Versioning.Version.Zero">
  13. <summary>
  14. Gets the zero version (0.0.0).
  15. </summary>
  16. </member>
  17. <member name="M:Hive.Versioning.Version.#ctor(Hive.Utilities.StringView)">
  18. <summary>
  19. Parses and creates a version object from a sequence of characters.
  20. </summary>
  21. <remarks>
  22. This is roughly equivalent to <see cref="M:Hive.Versioning.Version.Parse(Hive.Utilities.StringView)"/>.
  23. </remarks>
  24. <param name="text">The sequence of characters to parse as a version.</param>
  25. <exception cref="T:System.ArgumentException">Thrown when the input is not a valid SemVer version.</exception>
  26. </member>
  27. <member name="M:Hive.Versioning.Version.#ctor(System.UInt64,System.UInt64,System.UInt64,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})">
  28. <summary>
  29. Creates a version object from the component parts of the version.
  30. </summary>
  31. <param name="major">The major version number.</param>
  32. <param name="minor">The minor version number.</param>
  33. <param name="patch">The patch number.</param>
  34. <param name="prereleaseIds">A sequence of IDs specifying the prerelease.</param>
  35. <param name="buildIds">A sequence of IDs representing the build.</param>
  36. </member>
  37. <member name="M:Hive.Versioning.Version.#ctor(System.Int64,System.Int64,System.Int64,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})">
  38. <summary>
  39. Creates a version object from the component parts of the version.
  40. </summary>
  41. <remarks>
  42. <para>This interface is provided only for CLS compliance. The actual version number is unsigned.</para>
  43. <para>Because of this, very large version numbers may cause issues with this interface.</para>
  44. </remarks>
  45. <param name="major">The major version number.</param>
  46. <param name="minor">The minor version number.</param>
  47. <param name="patch">The patch number.</param>
  48. <param name="prereleaseIds">A sequence of IDs specifying the prerelease.</param>
  49. <param name="buildIds">A sequence of IDs representing the build.</param>
  50. </member>
  51. <member name="M:Hive.Versioning.Version.#ctor(System.UInt64,System.UInt64,System.UInt64)">
  52. <summary>
  53. Creates a version object from the component parts of the version.
  54. </summary>
  55. <param name="major">The major version number.</param>
  56. <param name="minor">The minor version number.</param>
  57. <param name="patch">The patch number.</param>
  58. </member>
  59. <member name="M:Hive.Versioning.Version.#ctor(System.Int64,System.Int64,System.Int64)">
  60. <summary>
  61. Creates a version object from the component parts of the version.
  62. </summary>
  63. <remarks>
  64. <para>This interface is provided only for CLS compliance. The actual version number is unsigned.</para>
  65. <para>Because of this, very large version numbers may cause issues with this interface.</para>
  66. </remarks>
  67. <param name="major">The major version number.</param>
  68. <param name="minor">The minor version number.</param>
  69. <param name="patch">The patch number.</param>
  70. </member>
  71. <member name="P:Hive.Versioning.Version.Major">
  72. <summary>
  73. Gets the major version number.
  74. </summary>
  75. </member>
  76. <member name="P:Hive.Versioning.Version.Minor">
  77. <summary>
  78. Gets the minor version number.
  79. </summary>
  80. </member>
  81. <member name="P:Hive.Versioning.Version.Patch">
  82. <summary>
  83. Gets the patch number.
  84. </summary>
  85. </member>
  86. <member name="P:Hive.Versioning.Version.PreReleaseIds">
  87. <summary>
  88. Gets the sequence of prerelease IDs.
  89. </summary>
  90. </member>
  91. <member name="P:Hive.Versioning.Version.BuildIds">
  92. <summary>
  93. Gets the sequence of build IDs.
  94. </summary>
  95. </member>
  96. <member name="M:Hive.Versioning.Version.GetVersionNumber(System.Int64@,System.Int64@,System.Int64@)">
  97. <summary>
  98. Vers the version number, as signed integers.
  99. </summary>
  100. <remarks>
  101. <para>This interface is provided only for CLS compliance. The actual version number is unsigned.</para>
  102. <para>Because of this, very large version numbers may cause issues with this interface.</para>
  103. </remarks>
  104. <param name="major">The major version number.</param>
  105. <param name="minor">The minor version number.</param>
  106. <param name="patch">The patch number.</param>
  107. </member>
  108. <member name="M:Hive.Versioning.Version.ToString(System.Text.StringBuilder)">
  109. <summary>
  110. Appends this <see cref="T:Hive.Versioning.Version"/> to the provided <see cref="T:System.Text.StringBuilder"/>.
  111. </summary>
  112. <param name="sb">The <see cref="T:System.Text.StringBuilder"/> to append to.</param>
  113. <returns>The provided <see cref="T:System.Text.StringBuilder"/></returns>
  114. </member>
  115. <member name="M:Hive.Versioning.Version.ToString">
  116. <inheritdoc/>
  117. </member>
  118. <member name="M:Hive.Versioning.Version.op_Equality(Hive.Versioning.Version,Hive.Versioning.Version)">
  119. <summary>
  120. Compares two versions for equality.
  121. </summary>
  122. <param name="a">The first version to compare.</param>
  123. <param name="b">The second version to compare.</param>
  124. <returns><see langword="true"/> if they are equal, <see langword="false"/> otherwise.</returns>
  125. </member>
  126. <member name="M:Hive.Versioning.Version.op_Inequality(Hive.Versioning.Version,Hive.Versioning.Version)">
  127. <summary>
  128. Compares two versions for inequality.
  129. </summary>
  130. <param name="a">The first version to compare.</param>
  131. <param name="b">The second version to compare.</param>
  132. <returns><see langword="true"/> if they are not equal, <see langword="false"/> otherwise.</returns>
  133. </member>
  134. <member name="M:Hive.Versioning.Version.op_GreaterThan(Hive.Versioning.Version,Hive.Versioning.Version)">
  135. <summary>
  136. Checks if <paramref name="a"/> is greater than <paramref name="b"/>.
  137. </summary>
  138. <param name="a">The first version to compare.</param>
  139. <param name="b">The second version to compare.</param>
  140. <returns><see langword="true"/> if <paramref name="a"/> is greater than <paramref name="b"/>, <see langword="false"/></returns>
  141. </member>
  142. <member name="M:Hive.Versioning.Version.op_LessThan(Hive.Versioning.Version,Hive.Versioning.Version)">
  143. <summary>
  144. Checks if <paramref name="a"/> is less than <paramref name="b"/>.
  145. </summary>
  146. <param name="a">The first version to compare.</param>
  147. <param name="b">The second version to compare.</param>
  148. <returns><see langword="true"/> if <paramref name="a"/> is less than <paramref name="b"/>, <see langword="false"/></returns>
  149. </member>
  150. <member name="M:Hive.Versioning.Version.op_GreaterThanOrEqual(Hive.Versioning.Version,Hive.Versioning.Version)">
  151. <summary>
  152. Checks if <paramref name="a"/> is greater than or equal to <paramref name="b"/>.
  153. </summary>
  154. <param name="a">The first version to compare.</param>
  155. <param name="b">The second version to compare.</param>
  156. <returns><see langword="true"/> if <paramref name="a"/> is greater than or equal to <paramref name="b"/>, <see langword="false"/></returns>
  157. </member>
  158. <member name="M:Hive.Versioning.Version.op_LessThanOrEqual(Hive.Versioning.Version,Hive.Versioning.Version)">
  159. <summary>
  160. Checks if <paramref name="a"/> is less than or equal to <paramref name="b"/>.
  161. </summary>
  162. <param name="a">The first version to compare.</param>
  163. <param name="b">The second version to compare.</param>
  164. <returns><see langword="true"/> if <paramref name="a"/> is less than or equal to <paramref name="b"/>, <see langword="false"/></returns>
  165. </member>
  166. <member name="M:Hive.Versioning.Version.Max(Hive.Versioning.Version,Hive.Versioning.Version)">
  167. <summary>
  168. Determines the maximum of two versions.
  169. </summary>
  170. <param name="a">The first version.</param>
  171. <param name="b">The second version.</param>
  172. <returns>The maximum of <paramref name="a"/> and <paramref name="b"/></returns>
  173. </member>
  174. <member name="M:Hive.Versioning.Version.Min(Hive.Versioning.Version,Hive.Versioning.Version)">
  175. <summary>
  176. Determines the minimum of two versions.
  177. </summary>
  178. <param name="a">The first version.</param>
  179. <param name="b">The second version.</param>
  180. <returns>The minimum of <paramref name="a"/> and <paramref name="b"/></returns>
  181. </member>
  182. <member name="M:Hive.Versioning.Version.Equals(System.Object)">
  183. <summary>
  184. Compares <see langword="this"/> version to <paramref name="obj"/> for equality.
  185. </summary>
  186. <param name="obj">The object to compare to.</param>
  187. <returns><see langword="true"/> if they are equal, <see langword="false"/> otherwise.</returns>
  188. </member>
  189. <member name="M:Hive.Versioning.Version.GetHashCode">
  190. <summary>
  191. Gets the hash code of this <see cref="T:Hive.Versioning.Version"/>.
  192. </summary>
  193. <returns>The hash code for this <see cref="T:Hive.Versioning.Version"/>.</returns>
  194. </member>
  195. <member name="M:Hive.Versioning.Version.Equals(Hive.Versioning.Version)">
  196. <summary>
  197. Compares this version to another version according to the SemVer specification.
  198. </summary>
  199. <param name="other">The version to compare to.</param>
  200. <returns><see langword="true"/> if the versions are equal, <see langword="false"/> otherwise.</returns>
  201. </member>
  202. <member name="M:Hive.Versioning.Version.CompareTo(Hive.Versioning.Version)">
  203. <summary>
  204. Compares this version to another version according to the SemVer specification.
  205. </summary>
  206. <param name="other">The version to compare to.</param>
  207. <returns>Less than zero if <see langword="this"/> is less than <paramref name="other"/>, zero if they are equal, and
  208. more than zero if <see langword="this"/> is greater than <paramref name="other"/></returns>
  209. </member>
  210. <member name="M:Hive.Versioning.Version.Parse(Hive.Utilities.StringView)">
  211. <summary>
  212. Parses a sequence of characters into a <see cref="T:Hive.Versioning.Version"/> object.
  213. </summary>
  214. <param name="text">The sequence of characters to parse.</param>
  215. <returns>The parsed version object.</returns>
  216. <exception cref="T:System.ArgumentException">Thrown when <paramref name="text"/> is not a valid SemVer version.</exception>
  217. </member>
  218. <member name="M:Hive.Versioning.Version.TryParse(Hive.Utilities.StringView,Hive.Versioning.Version@)">
  219. <summary>
  220. Attempts to parse a sequence of characters into a version object.
  221. </summary>
  222. <param name="text">The sequence of characters to parse.</param>
  223. <param name="version">The parsed version, if the input is valid.</param>
  224. <returns><see langword="true"/> if the text is valid and could be parsed, <see langword="false"/> otherwise.</returns>
  225. </member>
  226. <member name="M:Hive.Versioning.Version.TryParse(Hive.Utilities.StringView@,Hive.Versioning.Version@)">
  227. <summary>
  228. Attempts to parse a sequence of characters into a version object, as part of a larger parse.
  229. </summary>
  230. <remarks>
  231. When this method returns, <paramref name="text"/> will begin after the end of the parsed version, if it is present, or
  232. what it initially contained if no version is present and this returns <see langword="false"/>
  233. </remarks>
  234. <param name="text">The sequence of characters to parse.</param>
  235. <param name="version">The parsed version, if the input is valid.</param>
  236. <returns><see langword="true"/> if the text is valid and could be parsed, <see langword="false"/> otherwise.</returns>
  237. </member>
  238. <member name="T:Hive.Versioning.VersionRange">
  239. <summary>
  240. An arbitrary range of <see cref="T:Hive.Versioning.Version"/>s, capable of matching any possible set of <see cref="T:Hive.Versioning.Version"/>s.
  241. </summary>
  242. </member>
  243. <member name="M:Hive.Versioning.VersionRange.VersionComparer.Matches(Hive.Versioning.VersionRange.VersionComparer@)">
  244. <remarks>
  245. A <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/> is considered matching if it is exactly equivalent to this one, in addition to if its comparison
  246. value matches.
  247. </remarks>
  248. </member>
  249. <member name="M:Hive.Versioning.VersionRange.VersionComparer.ToExactEqualSubrange">
  250. <summary>
  251. Converts this <see cref="F:Hive.Versioning.VersionRange.ComparisonType.ExactEqual"/> <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/> to an equivalent <see cref="T:Hive.Versioning.VersionRange.Subrange"/>.
  252. </summary>
  253. <remarks>
  254. The returned <see cref="T:Hive.Versioning.VersionRange.Subrange"/> always takes the form <c>&gt;=Version &lt;=Version</c>.
  255. </remarks>
  256. <returns>The <see cref="T:Hive.Versioning.VersionRange.Subrange"/> that is equivalent to this <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/></returns>
  257. </member>
  258. <member name="M:Hive.Versioning.VersionRange.VersionComparer.Invert(Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.Subrange@)">
  259. <summary>
  260. Inverts this <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/> into either another <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/> or a <see cref="T:Hive.Versioning.VersionRange.Subrange"/>.
  261. </summary>
  262. <remarks>
  263. The only time this produces a <see cref="T:Hive.Versioning.VersionRange.Subrange"/> is when <see cref="F:Hive.Versioning.VersionRange.VersionComparer.Type"/> is <see cref="F:Hive.Versioning.VersionRange.ComparisonType.ExactEqual"/>.
  264. </remarks>
  265. <param name="comparer">The inverted <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/>, if any.</param>
  266. <param name="range">The <see cref="T:Hive.Versioning.VersionRange.Subrange"/> representing this <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/> inverted, if any.</param>
  267. <returns><see cref="F:Hive.Versioning.VersionRange.CombineResult.OneSubrange"/> if this produces a <see cref="T:Hive.Versioning.VersionRange.Subrange"/>, or <see cref="F:Hive.Versioning.VersionRange.CombineResult.OneComparer"/>
  268. if it produces a <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/>.</returns>
  269. </member>
  270. <member name="M:Hive.Versioning.VersionRange.VersionComparer.TryConjunction(Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.Subrange@)">
  271. <summary>
  272. Tries to perform a logical conjunction (and) with <paramref name="other"/>.
  273. </summary>
  274. <remarks>
  275. This method will only return one of the following values:
  276. <list type="table">
  277. <item>
  278. <term><see cref="F:Hive.Versioning.VersionRange.CombineResult.OneComparer"/></term>
  279. <description>A single <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/> was produced, and <paramref name="comparer"/> was set.</description>
  280. </item>
  281. <item>
  282. <term><see cref="F:Hive.Versioning.VersionRange.CombineResult.OneSubrange"/></term>
  283. <description>A single <see cref="T:Hive.Versioning.VersionRange.Subrange"/> was produced, and <paramref name="range"/> was set.</description>
  284. </item>
  285. <item>
  286. <term><see cref="F:Hive.Versioning.VersionRange.CombineResult.Nothing"/></term>
  287. <description>The conjunction result matches no possible values.</description>
  288. </item>
  289. </list>
  290. </remarks>
  291. <param name="other">The other <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/> to try to perform conjunction with.</param>
  292. <param name="comparer">The single <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/> the operation produced, if any.</param>
  293. <param name="range">The single <see cref="T:Hive.Versioning.VersionRange.Subrange"/> the operation produced, if any.</param>
  294. <returns>A <see cref="T:Hive.Versioning.VersionRange.CombineResult"/> indicating which of the outputs were set, if any.</returns>
  295. </member>
  296. <member name="M:Hive.Versioning.VersionRange.VersionComparer.TryConjunctionEqualPart(Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.CombineResult@)">
  297. <summary>
  298. A part of the implementation of <see cref="M:Hive.Versioning.VersionRange.VersionComparer.TryConjunction(Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.Subrange@)"/> that handles
  299. the cases where exactly one of the inputs are an <see cref="F:Hive.Versioning.VersionRange.ComparisonType.ExactEqual"/> comparer.
  300. </summary>
  301. </member>
  302. <member name="M:Hive.Versioning.VersionRange.VersionComparer.TryDisjunction(Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.Subrange@)">
  303. <summary>
  304. Tries to perform a logical disjunction (or) with <paramref name="other"/>.
  305. </summary>
  306. <remarks>
  307. This method will only return one of the following values:
  308. <list type="table">
  309. <item>
  310. <term><see cref="F:Hive.Versioning.VersionRange.CombineResult.OneComparer"/></term>
  311. <description>A single <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/> was produced, and <paramref name="comparer"/> was set.</description>
  312. </item>
  313. <item>
  314. <term><see cref="F:Hive.Versioning.VersionRange.CombineResult.OneSubrange"/></term>
  315. <description>A single <see cref="T:Hive.Versioning.VersionRange.Subrange"/> was produced, and <paramref name="range"/> was set.</description>
  316. </item>
  317. <item>
  318. <term><see cref="F:Hive.Versioning.VersionRange.CombineResult.Everything"/></term>
  319. <description>The disjunction result matches every valid value. For convenience,
  320. <paramref name="range"/> is set to <see cref="F:Hive.Versioning.VersionRange.Subrange.Everything"/>.</description>
  321. </item>
  322. <item>
  323. <term><see cref="F:Hive.Versioning.VersionRange.CombineResult.Unrepresentable"/></term>
  324. <description>The disjunction result is not representable with only a <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/> and a <see cref="T:Hive.Versioning.VersionRange.Subrange"/>.
  325. For example, if the inputs are non-equal <see cref="F:Hive.Versioning.VersionRange.ComparisonType.ExactEqual"/> comparers, this will be returned.</description>
  326. </item>
  327. </list>
  328. </remarks>
  329. <param name="other">The other <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/> to try to perform disjunction with.</param>
  330. <param name="comparer">The single <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/> the operation produced, if any.</param>
  331. <param name="range">The single <see cref="T:Hive.Versioning.VersionRange.Subrange"/> the operation produced, if any.</param>
  332. <returns>A <see cref="T:Hive.Versioning.VersionRange.CombineResult"/> indicating which of the outputs were set, if any.</returns>
  333. </member>
  334. <member name="M:Hive.Versioning.VersionRange.VersionComparer.TryDisjunctionEqualPart(Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.CombineResult@)">
  335. <summary>
  336. A part of the implementation of <see cref="M:Hive.Versioning.VersionRange.VersionComparer.TryDisjunction(Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.Subrange@)"/> that handles
  337. the cases where exactly one of the inputs are an <see cref="F:Hive.Versioning.VersionRange.ComparisonType.ExactEqual"/> comparer.
  338. </summary>
  339. </member>
  340. <member name="M:Hive.Versioning.VersionRange.Subrange.Matches(Hive.Versioning.VersionRange.VersionComparer@)">
  341. <remarks>
  342. This is identical to <see cref="M:Hive.Versioning.VersionRange.Subrange.Matches(Hive.Versioning.Version)"/> except that it uses <see cref="M:Hive.Versioning.VersionRange.VersionComparer.Matches(Hive.Versioning.VersionRange.VersionComparer@)"/>
  343. instead of <see cref="M:Hive.Versioning.VersionRange.VersionComparer.Matches(Hive.Versioning.Version)"/>.
  344. </remarks>
  345. </member>
  346. <member name="M:Hive.Versioning.VersionRange.Subrange.TryConjunction(Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.Subrange@)">
  347. <summary>
  348. Tries to perform a logical conjunction (and) with <paramref name="other"/>.
  349. </summary>
  350. <remarks>
  351. This method will only return one of the following values:
  352. <list type="table">
  353. <item>
  354. <term><see cref="F:Hive.Versioning.VersionRange.CombineResult.OneSubrange"/></term>
  355. <description>A single <see cref="T:Hive.Versioning.VersionRange.Subrange"/> was produced, and <paramref name="result"/> was set.</description>
  356. </item>
  357. <item>
  358. <term><see cref="F:Hive.Versioning.VersionRange.CombineResult.TwoSubranges"/></term>
  359. <description>Two <see cref="T:Hive.Versioning.VersionRange.Subrange"/>s were produced, and both <paramref name="result"/> and <paramref name="result2"/> were set.</description>
  360. </item>
  361. <item>
  362. <term><see cref="F:Hive.Versioning.VersionRange.CombineResult.Nothing"/></term>
  363. <description>The conjunction result matches no valid values.</description>
  364. </item>
  365. </list>
  366. </remarks>
  367. <param name="other">The other <see cref="T:Hive.Versioning.VersionRange.Subrange"/> to try to perform conjunction with.</param>
  368. <param name="result">The single (or first) <see cref="T:Hive.Versioning.VersionRange.Subrange"/> the operation produced, if any.</param>
  369. <param name="result2">The second <see cref="T:Hive.Versioning.VersionRange.Subrange"/> the operation produced, if any.</param>
  370. <returns>A <see cref="T:Hive.Versioning.VersionRange.CombineResult"/> indicating which of the outputs were set, if any.</returns>
  371. </member>
  372. <member name="M:Hive.Versioning.VersionRange.Subrange.TryConjunctionOneInwardPart(Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.CombineResult@)">
  373. <remarks>
  374. A part of the implementation of <see cref="M:Hive.Versioning.VersionRange.Subrange.TryConjunction(Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.Subrange@)"/>, handling the cases where exactly one
  375. input is an inward-facing <see cref="T:Hive.Versioning.VersionRange.Subrange"/>.
  376. </remarks>
  377. </member>
  378. <member name="M:Hive.Versioning.VersionRange.Subrange.TryDisjunction(Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.Subrange@)">
  379. <summary>
  380. Tries to perform a logical disjunction (or) with <paramref name="other"/>.
  381. </summary>
  382. <remarks>
  383. This method will only return one of the following values:
  384. <list type="table">
  385. <item>
  386. <term><see cref="F:Hive.Versioning.VersionRange.CombineResult.OneSubrange"/></term>
  387. <description>A single <see cref="T:Hive.Versioning.VersionRange.Subrange"/> was produced, and <paramref name="result"/> was set.</description>
  388. </item>
  389. <item>
  390. <term><see cref="F:Hive.Versioning.VersionRange.CombineResult.TwoSubranges"/></term>
  391. <description>Two <see cref="T:Hive.Versioning.VersionRange.Subrange"/>s were produced, and both <paramref name="result"/> and <paramref name="result2"/> were set.</description>
  392. </item>
  393. <item>
  394. <term><see cref="F:Hive.Versioning.VersionRange.CombineResult.Everything"/></term>
  395. <description>The disjunction result matches every valid value. For convenience,
  396. <paramref name="result"/> is set to <see cref="F:Hive.Versioning.VersionRange.Subrange.Everything"/>.</description>
  397. </item>
  398. </list>
  399. </remarks>
  400. <param name="other">The other <see cref="T:Hive.Versioning.VersionRange.Subrange"/> to try to perform disjunction with.</param>
  401. <param name="result">The single (or first) <see cref="T:Hive.Versioning.VersionRange.Subrange"/> the operation produced, if any.</param>
  402. <param name="result2">The second <see cref="T:Hive.Versioning.VersionRange.Subrange"/> the operation produced, if any.</param>
  403. <returns>A <see cref="T:Hive.Versioning.VersionRange.CombineResult"/> indicating which of the outputs were set, if any.</returns>
  404. </member>
  405. <member name="M:Hive.Versioning.VersionRange.Subrange.TryDisjunctionOneInwardPart(Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.CombineResult@)">
  406. <remarks>
  407. A part of the implementation of <see cref="M:Hive.Versioning.VersionRange.Subrange.TryDisjunction(Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.Subrange@,Hive.Versioning.VersionRange.Subrange@)"/>, handling the cases where exactly one
  408. input is an inward-facing <see cref="T:Hive.Versioning.VersionRange.Subrange"/>.
  409. </remarks>
  410. </member>
  411. <member name="M:Hive.Versioning.VersionRange.Subrange.TestExactMeeting(Hive.Versioning.VersionRange.VersionComparer@,Hive.Versioning.VersionRange.VersionComparer@)">
  412. <summary>
  413. Checks if two <see cref="T:Hive.Versioning.VersionRange.VersionComparer"/>s are mutually exclusive, but meet exactly leaving no versions that neither matches.
  414. </summary>
  415. </member>
  416. <member name="M:Hive.Versioning.VersionRange.#ctor(Hive.Utilities.StringView)">
  417. <summary>
  418. Constructs a new <see cref="T:Hive.Versioning.VersionRange"/> that corresponds to the text provided in <paramref name="text"/>.
  419. </summary>
  420. <param name="text">The textual represenation of the <see cref="T:Hive.Versioning.VersionRange"/> to create.</param>
  421. <seealso cref="M:Hive.Versioning.VersionRange.TryParse(Hive.Utilities.StringView@,Hive.Versioning.VersionRange@)"/>
  422. <exception cref="T:System.ArgumentException">Thrown when<paramref name="text"/> is not a valid <see cref="T:Hive.Versioning.VersionRange"/>.</exception>
  423. </member>
  424. <member name="M:Hive.Versioning.VersionRange.ForVersion(Hive.Versioning.Version)">
  425. <summary>
  426. Creates a <see cref="T:Hive.Versioning.VersionRange"/> which matches only the provided <paramref name="version"/>.
  427. </summary>
  428. <param name="version">The <see cref="T:Hive.Versioning.Version"/> to match.</param>
  429. <returns>A <see cref="T:Hive.Versioning.VersionRange"/> matching only the provided <paramref name="version"/>.</returns>
  430. </member>
  431. <member name="M:Hive.Versioning.VersionRange.Disjunction(Hive.Versioning.VersionRange)">
  432. <summary>
  433. Computes the logical disjunction (or) of this <see cref="T:Hive.Versioning.VersionRange"/> and <paramref name="other"/>.
  434. </summary>
  435. <param name="other">The other <see cref="T:Hive.Versioning.VersionRange"/> to compute the disjunction of.</param>
  436. <returns>The logical disjunction of <see langword="this"/> and <paramref name="other"/>.</returns>
  437. <seealso cref="M:Hive.Versioning.VersionRange.op_BitwiseOr(Hive.Versioning.VersionRange,Hive.Versioning.VersionRange)"/>
  438. </member>
  439. <member name="M:Hive.Versioning.VersionRange.op_BitwiseOr(Hive.Versioning.VersionRange,Hive.Versioning.VersionRange)">
  440. <summary>
  441. Computes the logical disjunction (or) of the two arguments.
  442. </summary>
  443. <param name="a">The first argument.</param>
  444. <param name="b">The second argument.</param>
  445. <returns>The logical disjunction of <paramref name="a"/> and <paramref name="b"/>.</returns>
  446. <seealso cref="M:Hive.Versioning.VersionRange.Disjunction(Hive.Versioning.VersionRange)"/>
  447. </member>
  448. <member name="M:Hive.Versioning.VersionRange.Conjunction(Hive.Versioning.VersionRange)">
  449. <summary>
  450. Computes the logical conjunction (and) of this <see cref="T:Hive.Versioning.VersionRange"/> and <paramref name="other"/>.
  451. </summary>
  452. <param name="other">The other <see cref="T:Hive.Versioning.VersionRange"/> to compute the conjunction of.</param>
  453. <returns>The logical conjunction of <see langword="this"/> and <paramref name="other"/>.</returns>
  454. <seealso cref="M:Hive.Versioning.VersionRange.op_BitwiseAnd(Hive.Versioning.VersionRange,Hive.Versioning.VersionRange)"/>
  455. </member>
  456. <member name="M:Hive.Versioning.VersionRange.op_BitwiseAnd(Hive.Versioning.VersionRange,Hive.Versioning.VersionRange)">
  457. <summary>
  458. Computes the logical conjunction (and) of the two arguments.
  459. </summary>
  460. <param name="a">The first argument.</param>
  461. <param name="b">The second argument.</param>
  462. <returns>The logical conjunction of <paramref name="a"/> and <paramref name="b"/>.</returns>
  463. <seealso cref="M:Hive.Versioning.VersionRange.Conjunction(Hive.Versioning.VersionRange)"/>
  464. </member>
  465. <member name="M:Hive.Versioning.VersionRange.Invert">
  466. <summary>
  467. Gets the compliement of this <see cref="T:Hive.Versioning.VersionRange"/>.
  468. </summary>
  469. <returns>The compliement of this <see cref="T:Hive.Versioning.VersionRange"/>.</returns>
  470. <seealso cref="M:Hive.Versioning.VersionRange.op_OnesComplement(Hive.Versioning.VersionRange)"/>
  471. </member>
  472. <member name="M:Hive.Versioning.VersionRange.op_OnesComplement(Hive.Versioning.VersionRange)">
  473. <summary>
  474. Computes the compliment of the argument.
  475. </summary>
  476. <param name="r">The <see cref="T:Hive.Versioning.VersionRange"/> to compute the compliment of.</param>
  477. <returns>The compliment of <paramref name="r"/>.</returns>
  478. <seealso cref="M:Hive.Versioning.VersionRange.Invert"/>
  479. </member>
  480. <member name="M:Hive.Versioning.VersionRange.Matches(Hive.Versioning.Version)">
  481. <summary>
  482. Determines whether or not a given <see cref="T:Hive.Versioning.Version"/> matches this <see cref="T:Hive.Versioning.VersionRange"/>.
  483. </summary>
  484. <param name="version">The <see cref="T:Hive.Versioning.Version"/> to check.</param>
  485. <returns><see langword="true"/> if <paramref name="version"/> matches, <see langword="false"/> otherwise.</returns>
  486. </member>
  487. <member name="P:Hive.Versioning.VersionRange.Everything">
  488. <summary>
  489. The <see cref="T:Hive.Versioning.VersionRange"/> that matches all <see cref="T:Hive.Versioning.Version"/>s.
  490. </summary>
  491. </member>
  492. <member name="P:Hive.Versioning.VersionRange.Nothing">
  493. <summary>
  494. The <see cref="T:Hive.Versioning.VersionRange"/> that matches no <see cref="T:Hive.Versioning.Version"/>s.
  495. </summary>
  496. </member>
  497. <member name="M:Hive.Versioning.VersionRange.ToString(System.Text.StringBuilder)">
  498. <summary>
  499. Appends the string representation of this <see cref="T:Hive.Versioning.VersionRange"/> to the provided <see cref="T:System.Text.StringBuilder"/>.
  500. </summary>
  501. <param name="sb">The <see cref="T:System.Text.StringBuilder"/> to append to.</param>
  502. <returns>The <see cref="T:System.Text.StringBuilder"/> that was appended to.</returns>
  503. </member>
  504. <member name="M:Hive.Versioning.VersionRange.ToString">
  505. <summary>
  506. Gets the string representation of this <see cref="T:Hive.Versioning.VersionRange"/>.
  507. </summary>
  508. <returns>The string representation of this <see cref="T:Hive.Versioning.VersionRange"/>.</returns>
  509. </member>
  510. <member name="M:Hive.Versioning.VersionRange.Equals(System.Object)">
  511. <inheritdoc/>
  512. </member>
  513. <member name="M:Hive.Versioning.VersionRange.Equals(Hive.Versioning.VersionRange)">
  514. <summary>
  515. Determines whether this <see cref="T:Hive.Versioning.VersionRange"/> is equivalent to another range.
  516. </summary>
  517. <param name="other">The <see cref="T:Hive.Versioning.VersionRange"/> to compare to.</param>
  518. <returns><see langword="true"/> if they are equivalent, <see langword="false"/> otherwise.</returns>
  519. </member>
  520. <member name="M:Hive.Versioning.VersionRange.GetHashCode">
  521. <inheritdoc/>
  522. </member>
  523. <member name="M:Hive.Versioning.VersionRange.op_Equality(Hive.Versioning.VersionRange,Hive.Versioning.VersionRange)">
  524. <summary>
  525. Compares two <see cref="T:Hive.Versioning.VersionRange"/>s for equality.
  526. </summary>
  527. <param name="a">The first argument.</param>
  528. <param name="b">The second argument.</param>
  529. <returns><see langword="true"/> if <paramref name="b"/> and <paramref name="b"/> are equivalent, <see langword="false"/> otherwise.</returns>
  530. </member>
  531. <member name="M:Hive.Versioning.VersionRange.op_Inequality(Hive.Versioning.VersionRange,Hive.Versioning.VersionRange)">
  532. <summary>
  533. Determines if two <see cref="T:Hive.Versioning.VersionRange"/>s are not equivalent.
  534. </summary>
  535. <param name="a">The first argument.</param>
  536. <param name="b">The second argument.</param>
  537. <returns><see langword="true"/> if <paramref name="b"/> and <paramref name="b"/> are not equivalent, <see langword="false"/> otherwise.</returns>
  538. </member>
  539. <member name="M:Hive.Versioning.VersionRange.Parse(Hive.Utilities.StringView)">
  540. <summary>
  541. Parses a string as a <see cref="T:Hive.Versioning.VersionRange" />.
  542. </summary>
  543. <remarks>
  544. <para>
  545. A valid <see cref="T:Hive.Versioning.VersionRange" /> string is made up of a set of disjoint regions joined by <c>||</c>.
  546. These regions can be either bounded or unbounded.
  547. <br />A bounded region is a pair of unbounded regions separated by whitespace, such that both unbounded regions overlap,
  548. and the unbounded region whose written value is lower comes first.
  549. <br />An unbounded region is any valid <see cref="T:Hive.Versioning.Version" /> prefixed with one of the following comparison operators:
  550. </para><list type="table">
  551. <item>
  552. <term><c>&gt;=</c></term>
  553. <description>The unbounded range matches any <see cref="T:Hive.Versioning.Version" /> greater than or equal to its specified <see cref="T:Hive.Versioning.Version" />.</description>
  554. </item>
  555. <item>
  556. <term><c>&lt;=</c></term>
  557. <description>The unbounded range matches any <see cref="T:Hive.Versioning.Version" /> less than or equal to its specified <see cref="T:Hive.Versioning.Version" />.</description>
  558. </item>
  559. <item>
  560. <term><c>&gt;</c></term>
  561. <description>The unbounded range matches any <see cref="T:Hive.Versioning.Version" /> greater than its specified <see cref="T:Hive.Versioning.Version" />.</description>
  562. </item>
  563. <item>
  564. <term><c>&lt;</c></term>
  565. <description>The unbounded range matches any <see cref="T:Hive.Versioning.Version" /> less than its specified <see cref="T:Hive.Versioning.Version" />.</description>
  566. </item>
  567. <item>
  568. <term><c>=</c></term>
  569. <description>The range matches only the <see cref="T:Hive.Versioning.Version" /> that it is specified with.</description>
  570. </item>
  571. </list><para>Note that unbounded ranges using the <c>=</c> comparison operator cannot be part of a bounded region.</para><para>Additionally, there are the following shorthand comparison operators that expand to bounded regions:</para><list type="table">
  572. <item>
  573. <term><c>^</c></term>
  574. <description>
  575. The bounded range matches all versions greater than or equal to its specified <see cref="T:Hive.Versioning.Version" /> and less than the next major incremented
  576. version. For example, <c>^1.5.4</c> would be equivalent to the bounded range <c>&gt;=1.5.4 &lt;2.0.0</c>, while <c>^0.4.2</c> would be equivalent
  577. to <c>&gt;=0.4.2 &lt;0.5.0</c>.
  578. </description>
  579. </item>
  580. </list><para>
  581. A bounded region may also be specified using star syntax. This takes the form of either a single <c>*</c> alone, matching any version,
  582. or a version with some numbers substituted with an asterisk. Once an element has been substituted, however, any following elements must
  583. either not be present or be a star themselves. Prereleases and build ids cannot be specified when using star syntax. For example,
  584. <c>*</c> is valid, <c>*.3</c> is not. <c>1.*</c> and <c>1.*.*</c> are valid (and equivalent), but <c>1.*.2</c> is not. <c>1.2.*</c> is
  585. valid, but <c>1.2.*-pre.1</c> is not. Importantly, <c>*.*.*</c> or anything similar is also not valid. Just use <c>*</c>.
  586. </para>
  587. </remarks>
  588. <param name="text">The stirng to parse.</param>
  589. <returns>The parsed <see cref="T:Hive.Versioning.VersionRange" />.</returns>
  590. <seealso cref="M:Hive.Versioning.VersionRange.TryParse(Hive.Utilities.StringView,Hive.Versioning.VersionRange@)" />
  591. <exception cref="T:System.ArgumentException">Thrown when <paramref name="text" /> is not a valid <see cref="T:Hive.Versioning.VersionRange" />.</exception>
  592. </member>
  593. <member name="M:Hive.Versioning.VersionRange.TryParse(Hive.Utilities.StringView,Hive.Versioning.VersionRange@)">
  594. <summary>
  595. Attempts to parse a whole string as a <see cref="T:Hive.Versioning.VersionRange" />.
  596. </summary>
  597. <remarks>
  598. <para>
  599. A valid <see cref="T:Hive.Versioning.VersionRange" /> string is made up of a set of disjoint regions joined by <c>||</c>.
  600. These regions can be either bounded or unbounded.
  601. <br />A bounded region is a pair of unbounded regions separated by whitespace, such that both unbounded regions overlap,
  602. and the unbounded region whose written value is lower comes first.
  603. <br />An unbounded region is any valid <see cref="T:Hive.Versioning.Version" /> prefixed with one of the following comparison operators:
  604. </para><list type="table">
  605. <item>
  606. <term><c>&gt;=</c></term>
  607. <description>The unbounded range matches any <see cref="T:Hive.Versioning.Version" /> greater than or equal to its specified <see cref="T:Hive.Versioning.Version" />.</description>
  608. </item>
  609. <item>
  610. <term><c>&lt;=</c></term>
  611. <description>The unbounded range matches any <see cref="T:Hive.Versioning.Version" /> less than or equal to its specified <see cref="T:Hive.Versioning.Version" />.</description>
  612. </item>
  613. <item>
  614. <term><c>&gt;</c></term>
  615. <description>The unbounded range matches any <see cref="T:Hive.Versioning.Version" /> greater than its specified <see cref="T:Hive.Versioning.Version" />.</description>
  616. </item>
  617. <item>
  618. <term><c>&lt;</c></term>
  619. <description>The unbounded range matches any <see cref="T:Hive.Versioning.Version" /> less than its specified <see cref="T:Hive.Versioning.Version" />.</description>
  620. </item>
  621. <item>
  622. <term><c>=</c></term>
  623. <description>The range matches only the <see cref="T:Hive.Versioning.Version" /> that it is specified with.</description>
  624. </item>
  625. </list><para>Note that unbounded ranges using the <c>=</c> comparison operator cannot be part of a bounded region.</para><para>Additionally, there are the following shorthand comparison operators that expand to bounded regions:</para><list type="table">
  626. <item>
  627. <term><c>^</c></term>
  628. <description>
  629. The bounded range matches all versions greater than or equal to its specified <see cref="T:Hive.Versioning.Version" /> and less than the next major incremented
  630. version. For example, <c>^1.5.4</c> would be equivalent to the bounded range <c>&gt;=1.5.4 &lt;2.0.0</c>, while <c>^0.4.2</c> would be equivalent
  631. to <c>&gt;=0.4.2 &lt;0.5.0</c>.
  632. </description>
  633. </item>
  634. </list><para>
  635. A bounded region may also be specified using star syntax. This takes the form of either a single <c>*</c> alone, matching any version,
  636. or a version with some numbers substituted with an asterisk. Once an element has been substituted, however, any following elements must
  637. either not be present or be a star themselves. Prereleases and build ids cannot be specified when using star syntax. For example,
  638. <c>*</c> is valid, <c>*.3</c> is not. <c>1.*</c> and <c>1.*.*</c> are valid (and equivalent), but <c>1.*.2</c> is not. <c>1.2.*</c> is
  639. valid, but <c>1.2.*-pre.1</c> is not. Importantly, <c>*.*.*</c> or anything similar is also not valid. Just use <c>*</c>.
  640. </para>
  641. </remarks>
  642. <param name="text">The string to try to parse.</param>
  643. <param name="range">The parsed <see cref="T:Hive.Versioning.VersionRange" />, if any.</param>
  644. <returns><see langword="true" /> if <paramref name="text" /> was successfully parsed, <see langword="false" /> otherwise.</returns>
  645. <seealso cref="M:Hive.Versioning.VersionRange.TryParse(Hive.Utilities.StringView@,Hive.Versioning.VersionRange@)" />
  646. </member>
  647. <member name="M:Hive.Versioning.VersionRange.TryParse(Hive.Utilities.StringView@,Hive.Versioning.VersionRange@)">
  648. <summary>
  649. Attempts to parse a <see cref="T:Hive.Versioning.VersionRange" /> from the start of the string.
  650. </summary>
  651. <remarks>
  652. <para>When this returns <see langword="true" />, <paramref name="text" /> will begin immediately after the parsed <see cref="T:Hive.Versioning.VersionRange" />.
  653. When this returns <see langword="false" />, <paramref name="text" /> will remain unchanged.</para>
  654. <para>
  655. A valid <see cref="T:Hive.Versioning.VersionRange" /> string is made up of a set of disjoint regions joined by <c>||</c>.
  656. These regions can be either bounded or unbounded.
  657. <br />A bounded region is a pair of unbounded regions separated by whitespace, such that both unbounded regions overlap,
  658. and the unbounded region whose written value is lower comes first.
  659. <br />An unbounded region is any valid <see cref="T:Hive.Versioning.Version" /> prefixed with one of the following comparison operators:
  660. </para><list type="table">
  661. <item>
  662. <term><c>&gt;=</c></term>
  663. <description>The unbounded range matches any <see cref="T:Hive.Versioning.Version" /> greater than or equal to its specified <see cref="T:Hive.Versioning.Version" />.</description>
  664. </item>
  665. <item>
  666. <term><c>&lt;=</c></term>
  667. <description>The unbounded range matches any <see cref="T:Hive.Versioning.Version" /> less than or equal to its specified <see cref="T:Hive.Versioning.Version" />.</description>
  668. </item>
  669. <item>
  670. <term><c>&gt;</c></term>
  671. <description>The unbounded range matches any <see cref="T:Hive.Versioning.Version" /> greater than its specified <see cref="T:Hive.Versioning.Version" />.</description>
  672. </item>
  673. <item>
  674. <term><c>&lt;</c></term>
  675. <description>The unbounded range matches any <see cref="T:Hive.Versioning.Version" /> less than its specified <see cref="T:Hive.Versioning.Version" />.</description>
  676. </item>
  677. <item>
  678. <term><c>=</c></term>
  679. <description>The range matches only the <see cref="T:Hive.Versioning.Version" /> that it is specified with.</description>
  680. </item>
  681. </list><para>Note that unbounded ranges using the <c>=</c> comparison operator cannot be part of a bounded region.</para><para>Additionally, there are the following shorthand comparison operators that expand to bounded regions:</para><list type="table">
  682. <item>
  683. <term><c>^</c></term>
  684. <description>
  685. The bounded range matches all versions greater than or equal to its specified <see cref="T:Hive.Versioning.Version" /> and less than the next major incremented
  686. version. For example, <c>^1.5.4</c> would be equivalent to the bounded range <c>&gt;=1.5.4 &lt;2.0.0</c>, while <c>^0.4.2</c> would be equivalent
  687. to <c>&gt;=0.4.2 &lt;0.5.0</c>.
  688. </description>
  689. </item>
  690. </list><para>
  691. A bounded region may also be specified using star syntax. This takes the form of either a single <c>*</c> alone, matching any version,
  692. or a version with some numbers substituted with an asterisk. Once an element has been substituted, however, any following elements must
  693. either not be present or be a star themselves. Prereleases and build ids cannot be specified when using star syntax. For example,
  694. <c>*</c> is valid, <c>*.3</c> is not. <c>1.*</c> and <c>1.*.*</c> are valid (and equivalent), but <c>1.*.2</c> is not. <c>1.2.*</c> is
  695. valid, but <c>1.2.*-pre.1</c> is not. Importantly, <c>*.*.*</c> or anything similar is also not valid. Just use <c>*</c>.
  696. </para>
  697. </remarks>
  698. <param name="text">The string to try to parse.</param>
  699. <param name="range">The parsed <see cref="T:Hive.Versioning.VersionRange" />, if any.</param>
  700. <returns><see langword="true" /> if <paramref name="text" /> was successfully parsed, <see langword="false" /> otherwise.</returns>
  701. </member>
  702. <member name="P:Hive.Versioning.Resources.SR.ResourceManager">
  703. <summary>
  704. Returns the cached ResourceManager instance used by this class.
  705. </summary>
  706. </member>
  707. <member name="P:Hive.Versioning.Resources.SR.Culture">
  708. <summary>
  709. Overrides the current thread's CurrentUICulture property for all
  710. resource lookups using this strongly typed resource class.
  711. </summary>
  712. </member>
  713. <member name="P:Hive.Versioning.Resources.SR.AssertionFailed">
  714. <summary>
  715. Gets a resource string for AssertionFailed similar to ''.
  716. </summary>
  717. </member>
  718. <member name="P:Hive.Versioning.Resources.SR.Range_InputInvalid">
  719. <summary>
  720. Gets a resource string for Range_InputInvalid similar to 'Input is not a valid VersionRange'.
  721. </summary>
  722. </member>
  723. <member name="P:Hive.Versioning.Resources.SR.Version_InputInvalid">
  724. <summary>
  725. Gets a resource string for Version_InputInvalid similar to 'Input was not a valid SemVer version'.
  726. </summary>
  727. </member>
  728. <member name="P:Hive.Versioning.Resources.SR.Version_InputTooShort">
  729. <summary>
  730. Gets a resource string for Version_InputTooShort similar to 'Input too short to be a SemVer version'.
  731. </summary>
  732. </member>
  733. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
  734. <summary>
  735. Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>,
  736. the parameter may be <see langword="null"/> even if the corresponding type disallows it.
  737. </summary>
  738. </member>
  739. <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
  740. <summary>
  741. Initializes the attribute with the specified return value condition.
  742. </summary>
  743. <param name="returnValue">The return value condition. If the method returns this
  744. value, the associated parameter may be null.</param>
  745. </member>
  746. <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
  747. <summary>
  748. Gets the return value condition.
  749. </summary>
  750. <value>The return value condition. If the method returns this value, the
  751. associated parameter may be null.</value>
  752. </member>
  753. <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
  754. <summary>
  755. Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>,
  756. the parameter is not <see langword="null"/> even if the corresponding type allows it.
  757. </summary>
  758. </member>
  759. <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
  760. <summary>
  761. Initializes the attribute with the specified return value condition.
  762. </summary>
  763. <param name="returnValue">The return value condition. If the method returns this
  764. value, the associated parameter is not null.</param>
  765. </member>
  766. <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
  767. <summary>
  768. Gets the return value condition.
  769. </summary>
  770. <value>The return value condition. If the method returns this value, the
  771. associated parameter is not null.</value>
  772. </member>
  773. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
  774. <summary>
  775. Specifies that an output may be <see langword="null"/> even if the corresponding type disallows it.
  776. </summary>
  777. </member>
  778. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
  779. <summary>
  780. Specifies that the method will not return if the associated Boolean parameter is passed the specified value.
  781. </summary>
  782. </member>
  783. <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
  784. <summary>
  785. Initializes the attribute with the specified parameter value.
  786. </summary>
  787. <param name="parameterValue">
  788. The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
  789. the associated parameter matches this value.
  790. </param>
  791. </member>
  792. <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
  793. <summary>
  794. Gets the condition parameter value.
  795. </summary>
  796. </member>
  797. </members>
  798. </doc>