Skip to content

Commit

Permalink
Increase version to 2.5.2 and fix some warnings in doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
qwertie committed Feb 17, 2017
1 parent e2635a7 commit 4237266
Show file tree
Hide file tree
Showing 40 changed files with 96 additions and 90 deletions.
4 changes: 2 additions & 2 deletions Baadia/Shapes/Shape.cs
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ public virtual Shape Clone()
/// <returns>Null indicates a failed hit test. Inside the result object, the
/// cursor <see cref="Cursors.Arrow"/> means that the shape is selectable,
/// <see cref="Cursors.SizeAll"/> indicates that the user will be moving something,
/// and a sizing cursor such as <see cref="SizeNS"/> indicates that something will
/// be resized or that one line in a collection of lines will be moved along the
/// and a sizing cursor such as <see cref="Cursors.SizeNS"/> indicates that something
/// will be resized or that one line in a collection of lines will be moved along the
/// indicated direction (e.g. up-down for SizeNS).</returns>
public abstract HitTestResult HitTest(PointT pos, VectorT hitTestRadius, SelType sel);

Expand Down
2 changes: 1 addition & 1 deletion Baadia/Util/GestureAnalyzer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public enum SelType
No, Yes, Partial
}

/// <summary>Base class for results returned from <see cref="IInputWidget.HitTest()"/>.</summary>
/// <summary>Base class for results returned from <see cref="IInputWidget.HitTest"/>.</summary>
public class HitTestResult
{
public HitTestResult(IShapeWidget shape, Cursor cursor)
Expand Down
2 changes: 1 addition & 1 deletion Baadia/Util/ICommand etc.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ namespace Util.UI
/// return true;
/// }
/// </code>
/// The static method <see cref="CommandAttribute.GetCommandList()"/> converts
/// The static method <see cref="CommandAttribute.GetCommandList"/> converts
/// all the methods that are marked with [Command] into ICommand objects. If
/// 'run' is false, the action must not be taken; the method must simply return
/// true if the command is available and false if not.
Expand Down
2 changes: 1 addition & 1 deletion Baadia/Util/LLShapeControl.cs
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ protected override void OnPaintBackground(PaintEventArgs pevent)
/// or when <i>all</i> the layers underneath rarely change. Also, the alpha
/// channel should be disabled on the first layer.
/// <para/>
/// When calling <see cref="LLShapeControl.Add"/>, you can specify
/// When calling <see cref="LLShapeControl.AddLayer"/>, you can specify
/// <c>useAlpha: null</c> to decide automatically based on the number of shapes
/// in the layer.
/// <para/>
Expand Down
2 changes: 1 addition & 1 deletion Baadia/Util/OwnedList.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public interface IHasParent<out TParent>
TParent Parent { get; }
}

/// <summary>A variation of <see cref="IChildOf{P}"/> that has a <see cref="Parent"/> property.</summary>
/// <summary>A variation of <see cref="IChildOf{P}"/> that has a Parent property.</summary>
/// <seealso cref="ChildOfOneParent{Parent}"/>
public interface IChildOfOneParent<TParent> : IChildOf<TParent>, IHasParent<TParent> {}

Expand Down
2 changes: 1 addition & 1 deletion Baadia/Util/UndoStack.cs
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ public virtual bool Redo(bool run = true)
/// <remarks>All tentative actions pending at the same time are placed
/// in the same undo group. Call <see cref="AcceptTentativeAction"/> or
/// <see cref="Do"/> to finalize, or <see cref="UndoTetativeAction"/> to
/// undo.
/// undo.</remarks>
public virtual void DoTentatively(DoOrUndo action)
{
_tempStack.Add(new Command(action, false).Do());
Expand Down
4 changes: 2 additions & 2 deletions Core/AssemblyVersion.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@
// from linking together without an exact match - and now that I'm no longer using
// '.*' I am still having occasional problems with 'MissingMethodException' in the
// Visual Studio SFG, but I don't know why, maybe it's not about version numbers..)
[assembly: AssemblyVersion("2.5.1.0")]
[assembly: AssemblyFileVersion("2.5.1.0")]
[assembly: AssemblyVersion("2.5.2.0")]
[assembly: AssemblyFileVersion("2.5.2.0")]
5 changes: 2 additions & 3 deletions Core/Loyc.Collections/ALists/BMultiMap.cs
Original file line number Diff line number Diff line change
Expand Up @@ -366,9 +366,8 @@ public int FindLowerBound(ref K key, out V value, out bool found)
/// <param name="key">The key to find. If passed by reference, when this
/// method returns, item is set to the next greater item than the item you
/// searched for, or left unchanged if there is no greater item.</param>
/// <param name="index">The index of the next greater item that was found,
/// or Count if the given item is greater than all items in the list.</param>
/// <returns></returns>
/// <returns>The index of the next greater item that was found,
/// or Count if the given item is greater than all items in the list.</returns>
public int FindUpperBound(K key)
{
var op = new AListSingleOperation<KeyValuePair<K, V>, KeyValuePair<K, V>>();
Expand Down
2 changes: 1 addition & 1 deletion Core/Loyc.Essentials/Collections/Adapters/NegList.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public static NegList<T> AsNegList<T>(this IListAndListSource<T> list, int zeroO

/// <summary>
/// Adapter: provides a view of an <see cref="IList{T}"/> in which the Count is the same, but the
/// minimum index is not necessarily zero. Returned from <see cref="LCExt.NegView{T}(IList{T},int)"/>.
/// minimum index is not necessarily zero. Returned from <see cref="LCExt.AsNegList{T}(IList{T},int)"/>.
/// </summary>
/// <remarks>This wrapper is a structure in order to offer high performance in
/// certain scenarios.</remarks>
Expand Down
2 changes: 1 addition & 1 deletion Core/Loyc.Essentials/Collections/Adapters/NegListSource.cs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public static NegListSource<T> AsNegList<T>(this IListSource<T> list, int zeroOf
/// <summary>
/// Adapter: provides a view of an <see cref="IListSource{T}"/> in which the Count
/// is the same, but the minimum index is not necessarily zero. Returned from
/// <see cref="LCExt.NegView{T}(IListSource{T},int)"/>.
/// <see cref="LCExt.AsNegList{T}(IListSource{T},int)"/>.
/// </summary>
/// <remarks>
/// This wrapper is a structure in order to offer high performance in certain
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
namespace Loyc.Collections
{
/// <summary>Adapter: reversed view of <see cref="IListSource{T}"/> returned
/// from <see cref="LCExt.Reverse{T}"/>.</summary>
/// from <see cref="LinqToLists.Reverse{T}"/>.</summary>
[Serializable]
public class ReversedListSource<T> : ListSourceBase<T>
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ namespace Loyc.Collections
/// <summary>Returns a slice of the initial elements of the list that meet the provided criteria.
/// The word "now" is added to the name because unlike Enumerable.TakeWhile, this method scans
/// the list immediately.</summary>
/// <remarks>Example: new[] { 3, 6, 9, 12, 1, 2 }.TakeNowWhile(n => n < 10) returns a slice
/// <remarks>Example: new[] { 13, 16, 19, 2, 11, 12 }.TakeNowWhile(n => n > 10) returns a slice
/// (not a copy) of the first 3 elements.</remarks>
public static $ListSlice<T> TakeNowWhile<T>(this $IList<T> list, Func<T, bool> predicate)
{
Expand All @@ -149,7 +149,7 @@ namespace Loyc.Collections
/// <summary>Returns a slice without the initial elements of the list that meet the specified
/// criteria. The word "now" is added to the name because unlike Enumerable.SkipWhile, this
/// method scans the list immediately.</summary>
/// <remarks>Example: new[] { 4, 8, 12, 2, 10 }.SkipNowWhile(n => n < 10) returns a slice
/// <remarks>Example: new[] { 24, 28, 2, 12, 11 }.SkipNowWhile(n => n > 10) returns a slice
/// (not a copy) of the last 2 elements.</remarks>
public static $ListSlice<T> SkipNowWhile<T>(this $IList<T> list, Func<T, bool> predicate)
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Generated from LinqToLists.ecs by LeMP custom tool. LeMP version: 2.4.0.1
// Generated from LinqToLists.ecs by LeMP custom tool. LeMP version: 2.5.1.0
// Note: you can give command-line arguments to the tool via 'Custom Tool Namespace':
// --no-out-header Suppress this message
// --verbose Allow verbose messages (shown by VS as 'warnings')
Expand All @@ -18,7 +18,7 @@ namespace Loyc.Collections
/// </summary><remarks>
/// For example, the <see cref="Enumerable.Last()"/> extension
/// method scans the entire list before returning the last item, while
/// <see cref="Last(IReadOnlyList{T})"/> and <see cref="Last(IList{T})"/> simply
/// <see cref="Last{T}(IReadOnlyList{T})"/> and <see cref="Last{T}(IList{T})"/> simply
/// return the last item directly.
/// </remarks>
public static partial class LinqToLists
Expand Down Expand Up @@ -177,7 +177,7 @@ public static NegListSlice<T> Take<T>(this INegListSource<T> list, int count)
/// <summary>Returns a slice of the initial elements of the list that meet the provided criteria.
/// The word "now" is added to the name because unlike Enumerable.TakeWhile, this method scans
/// the list immediately.</summary>
/// <remarks>Example: new[] { 3, 6, 9, 12, 1, 2 }.TakeNowWhile(n => n < 10) returns a slice
/// <remarks>Example: new[] { 13, 16, 19, 2, 11, 12 }.TakeNowWhile(n => n > 10) returns a slice
/// (not a copy) of the first 3 elements.</remarks>
public static ListSlice<T> TakeNowWhile<T>(this IList<T> list, Func<T, bool> predicate)
{
Expand All @@ -192,7 +192,7 @@ public static ListSlice<T> TakeNowWhile<T>(this IList<T> list, Func<T, bool> pre
/// <summary>Returns a slice without the initial elements of the list that meet the specified
/// criteria. The word "now" is added to the name because unlike Enumerable.SkipWhile, this
/// method scans the list immediately.</summary>
/// <remarks>Example: new[] { 4, 8, 12, 2, 10 }.SkipNowWhile(n => n < 10) returns a slice
/// <remarks>Example: new[] { 24, 28, 2, 12, 11 }.SkipNowWhile(n => n > 10) returns a slice
/// (not a copy) of the last 2 elements.</remarks>
public static ListSlice<T> SkipNowWhile<T>(this IList<T> list, Func<T, bool> predicate)
{
Expand All @@ -208,7 +208,7 @@ public static ListSlice<T> SkipNowWhile<T>(this IList<T> list, Func<T, bool> pre
/// <summary>Returns a slice of the initial elements of the list that meet the provided criteria.
/// The word "now" is added to the name because unlike Enumerable.TakeWhile, this method scans
/// the list immediately.</summary>
/// <remarks>Example: new[] { 3, 6, 9, 12, 1, 2 }.TakeNowWhile(n => n < 10) returns a slice
/// <remarks>Example: new[] { 13, 16, 19, 2, 11, 12 }.TakeNowWhile(n => n > 10) returns a slice
/// (not a copy) of the first 3 elements.</remarks>
public static Slice_<T> TakeNowWhile<T>(this IListSource<T> list, Func<T, bool> predicate)
{
Expand All @@ -223,7 +223,7 @@ public static Slice_<T> TakeNowWhile<T>(this IListSource<T> list, Func<T, bool>
/// <summary>Returns a slice without the initial elements of the list that meet the specified
/// criteria. The word "now" is added to the name because unlike Enumerable.SkipWhile, this
/// method scans the list immediately.</summary>
/// <remarks>Example: new[] { 4, 8, 12, 2, 10 }.SkipNowWhile(n => n < 10) returns a slice
/// <remarks>Example: new[] { 24, 28, 2, 12, 11 }.SkipNowWhile(n => n > 10) returns a slice
/// (not a copy) of the last 2 elements.</remarks>
public static Slice_<T> SkipNowWhile<T>(this IListSource<T> list, Func<T, bool> predicate)
{
Expand All @@ -239,7 +239,7 @@ public static Slice_<T> SkipNowWhile<T>(this IListSource<T> list, Func<T, bool>
/// <summary>Returns a slice of the initial elements of the list that meet the provided criteria.
/// The word "now" is added to the name because unlike Enumerable.TakeWhile, this method scans
/// the list immediately.</summary>
/// <remarks>Example: new[] { 3, 6, 9, 12, 1, 2 }.TakeNowWhile(n => n < 10) returns a slice
/// <remarks>Example: new[] { 13, 16, 19, 2, 11, 12 }.TakeNowWhile(n => n > 10) returns a slice
/// (not a copy) of the first 3 elements.</remarks>
public static NegListSlice<T> TakeNowWhile<T>(this INegListSource<T> list, Func<T, bool> predicate)
{
Expand All @@ -254,7 +254,7 @@ public static NegListSlice<T> TakeNowWhile<T>(this INegListSource<T> list, Func<
/// <summary>Returns a slice without the initial elements of the list that meet the specified
/// criteria. The word "now" is added to the name because unlike Enumerable.SkipWhile, this
/// method scans the list immediately.</summary>
/// <remarks>Example: new[] { 4, 8, 12, 2, 10 }.SkipNowWhile(n => n < 10) returns a slice
/// <remarks>Example: new[] { 24, 28, 2, 12, 11 }.SkipNowWhile(n => n > 10) returns a slice
/// (not a copy) of the last 2 elements.</remarks>
public static NegListSlice<T> SkipNowWhile<T>(this INegListSource<T> list, Func<T, bool> predicate)
{
Expand Down
2 changes: 1 addition & 1 deletion Core/Loyc.Essentials/Collections/HelperClasses/Repeated.cs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public static Repeated<T> Single<T>(T value)

/// <summary>Helper struct. A sequence that stores one value, but acts like a list in which
/// that value is repeated a specified number of times. Returned from
/// <see cref="Range.Repeat{T}"/>.</summary>
/// <see cref="ListExt.Repeat{T}(T, int)"/>.</summary>
[Serializable]
public struct Repeated<T> : IListAndListSource<T>, IRange<T>, IIsEmpty
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ namespace Loyc.Collections
/// <summary>
/// Helper class: provides a modified view of an IList by transforming each element
/// on-demand. Objects of this type are returned from
/// <see cref="LinqToCollections.Select{T,TResult}(IList{T},Func{T,TResult})"/>
/// <see cref="LinqToLists.Select{T,TResult}(IList{T},Func{T,TResult})"/>
/// </summary>
/// <typeparam name="T">input type</typeparam>
/// <typeparam name="TResult">output type</typeparam>
Expand Down Expand Up @@ -53,7 +53,7 @@ public sealed override int Count
/// <summary>
/// Helper class: provides a modified view of an IListSource by transforming each element
/// on-demand. Objects of this type are returned from
/// <see cref="LinqToCollections.Select{T,TResult}(IListSource{T},Func{T,TResult})"/>
/// <see cref="LinqToLists.Select{T,TResult}(IListSource{T},Func{T,TResult})"/>
/// </summary>
/// <typeparam name="T">input type</typeparam>
/// <typeparam name="TResult">output type</typeparam>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ namespace Loyc.Collections
/// <para/>
/// An optimization is available when only a single item is being added or
/// changed. In that case, the collection class should create a lightweight
/// read-only single-item list by calling <see cref="Range.Single{T}(T)"/>.
/// read-only single-item list by calling <see cref="ListExt.Single{T}(T)"/>.
/// Such a list has less overhead than <see cref="List{T}"/> and the same
/// overhead as an array of one item.
/// </remarks>
Expand Down
3 changes: 2 additions & 1 deletion Core/Loyc.Essentials/Geometry/IRectangle.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ public interface ISizeReader<T>
/// <para/>
/// A rectangle may or may not require X2 >= X1 and Y2 >= Y1. If X1>X2 or
/// Y1>Y2, the rectangle is said to be "not normalized" and the
/// <see cref="RectangleExt.IsNormal"/> extension method returns false.
/// <see cref="RectangleExt.IsNormal{Rect, T}(Rect)"/> extension method
/// returns false.
/// </remarks>
public interface IRectangleReader<T> : ISizeReader<T>
{
Expand Down
2 changes: 1 addition & 1 deletion Core/Loyc.Essentials/Geometry/IRectangle3.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public interface ISize3Reader<T> : ISizeReader<T>
/// <para/>
/// The object may or may not require X2 >= X1 and Y2 >= Y1 and Z2 >= Z1.
/// If X1>X2 or Y1>Y2 or Z1>Z2, the rectangle is said to be "not
/// normalized" and the <see cref="Rectangle3Ext.IsNormal"/> extension
/// normalized" and the <see cref="Rectangle3Ext.IsNormal{Rect,T}(Rect)"/> extension
/// method returns false.
/// </remarks>
public interface IRectangle3Reader<T> : IRectangleReader<T>, ISize3Reader<T>
Expand Down
8 changes: 2 additions & 6 deletions Core/Loyc.Essentials/MessageSinks/IMessageSink.cs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ namespace Loyc
/// sink itself should perform localization using <see
/// cref="Localize.Localized(string, object[])"/>.
/// <para/>
/// Only a single Write() method is truly needed (<see cref="Write(Severity, object, string, object[])"/>),
/// Only a single Write() method is truly needed (<see cref="Write(Severity, TContext, string, object[])"/>),
/// but for efficiency reasons the interface contains two other writers. It
/// is expected to be fairly common that a message sink will drop some or
/// all messages without printing them, e.g. if a message sink is used for
Expand All @@ -61,10 +61,6 @@ namespace Loyc
/// doing any work required to prepare a message for printing when a certain
/// category of output is disabled.
/// </remarks>
/// <typeparam name="TSeverity">The type of the first parameter to <c>Write</c>,
/// which is used to indicate the "kind" of message being logged. Typically this
/// parameter is <see cref="Severity"/>, which includes values like Note, Warning
/// and Error.</typeparam>
/// <typeparam name="TContext">The type of the second parameer to <c>Write</c>,
/// which indicates where the error occurs. If the message relates to a text
/// file or source code, the location is typically indicated with an object of
Expand All @@ -80,7 +76,7 @@ namespace Loyc
public interface IMessageSink<in TContext>
{
/// <summary>Writes a message to the target that this object represents.</summary>
/// <param name="type">Severity or importance of the message; widely-used
/// <param name="level">Severity or importance of the message; widely-used
/// types include Error, Warning, Note, Debug, and Verbose. The special
/// type Detail is intended to provide more information about a previous
/// message.</param>
Expand Down
3 changes: 2 additions & 1 deletion Core/Loyc.Essentials/MessageSinks/MessageHolder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ public MessageHolder Clone()
}
}

/// <summary>Holds an argument list compatible with <see cref="IMessageSink.Write"/>.
/// <summary>Holds an argument list compatible with
/// <see cref="IMessageSink{TContext}.Write(Severity,TContext,string)"/>.
/// Typically used with <see cref="MessageHolder"/>.</summary>
public struct LogMessage : IHasLocation
{
Expand Down
2 changes: 1 addition & 1 deletion Core/Loyc.Essentials/MessageSinks/MessageSink.out.cs
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ public static MessageSinkFromDelegate FromDelegate(WriteMessageFn writer, Func<S
return new MessageSinkFromDelegate(writer, isEnabled);
}

/// <summary>Creates a message sink that writes to <see cref="MessageSink.Default"> with a default context to be used
/// <summary>Creates a message sink that writes to <see cref="MessageSink.Default"/> with a default context to be used
/// when <c>Write</c> is called with <c>context: null</c>, so that you
/// can use extension methods like <c>Error(string)</c> that do not
/// have any context parameter.</summary>
Expand Down
2 changes: 1 addition & 1 deletion Core/Loyc.Essentials/MessageSinks/WrapperSinks.cs
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ public IMessageSink<TContext> Target
/// <c>messagePrefix</c> to avoid accidental misbehavior when the string is formatted.
/// <b>Note:</b> in fact, <c>messagePrefix</c> should not contain braces at all,
/// because message formatting is optional. <see cref="Write(Severity, TContext, string)"/>
/// does not perform formatting while <see cref="Write(Severity, TContext, string, params object[])"/>
/// does not perform formatting while <see cref="Write(Severity, TContext, string, object[])"/>
/// does. Consequently, when calling the first overload, the scrubbing process will
/// cause braces in <c>messagePrefix</c> to be doubled as in "{{" or "}}". We could
/// fix this by storing two separate MessagePrefix strings in this object, one
Expand Down
4 changes: 2 additions & 2 deletions Core/Loyc.Essentials/Strings/StringExt.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
namespace Loyc
{
/// <summary>Extension methods for strings, such as <see cref="SplitAt"/>,
/// <see cref="Left"/>, <see cref="Right"/>, <see cref="Format"/> and <see cref="Slice"/>.</summary>
/// <see cref="Left"/>, <see cref="Right"/>, <see cref="FormatCore"/> and <see cref="Slice"/>.</summary>
public static partial class StringExt
{
/// <summary>Gets the substrings to the left and right of a dividing character.</summary>
Expand Down Expand Up @@ -171,7 +171,7 @@ public static string FormatCore(this string format, params object[] args)
/// <summary>Called by Format to replace named placeholders with numeric
/// placeholders in format strings.</summary>
/// <returns>A format string that can be used to call string.Format.</returns>
/// <seealso cref="Format"/>
/// <seealso cref="FormatCore"/>
public static string EliminateNamedArgs(string format, params object[] args)
{
char c;
Expand Down
5 changes: 3 additions & 2 deletions Core/Loyc.Essentials/Utilities/G.cs
Original file line number Diff line number Diff line change
Expand Up @@ -213,9 +213,10 @@ public static bool Verify(bool condition)
static Dictionary<char, string> HtmlEntityTable;

/// <summary>Gets a bare HTML entity name for an ASCII character, or null if
/// there is no entity name for the given character, e.g. <c>'"'=>"quot"</c>.
/// there is no entity name for the given character, e.g.
/// <c>BareHtmlEntityNameForAscii('"') == "quot"</c>.
/// </summary><remarks>
/// The complete entity name is <c>"&" + GetHtmlEntityNameForAscii(c) + ";"</c>.
/// The complete entity name is an ampersand (&amp;) plus <c>BareHtmlEntityNameForAscii(c) + ";"</c>.
/// Some HTML entities have multiple names; this function returns one of them.
/// There is a name in this table for all ASCII punctuation characters.
/// </remarks>
Expand Down
Loading

0 comments on commit 4237266

Please sign in to comment.