Repository: lucenenet Updated Branches: refs/heads/master 032d49ac8 -> 3e9c4ab0a
Fixed Codec factory documentation comments Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/3e9c4ab0 Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/3e9c4ab0 Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/3e9c4ab0 Branch: refs/heads/master Commit: 3e9c4ab0a44adf1d43c245e63e840195780277cd Parents: 032d49a Author: Shad Storhaug <[email protected]> Authored: Thu May 18 20:04:10 2017 +0700 Committer: Shad Storhaug <[email protected]> Committed: Thu May 18 20:04:10 2017 +0700 ---------------------------------------------------------------------- src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs | 4 ++-- .../Support/Codecs/DefaultDocValuesFormatFactory.cs | 6 +++--- .../Support/Codecs/DefaultPostingsFormatFactory.cs | 10 +++++----- src/Lucene.Net/Support/Util/ExcludeServiceAttribute.cs | 3 +++ src/Lucene.Net/Support/Util/IServiceListable.cs | 4 ++++ src/Lucene.Net/Support/Util/ServiceNameAttribute.cs | 7 +++++++ 6 files changed, 24 insertions(+), 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3e9c4ab0/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs b/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs index 18084c9..8c1ecb1 100644 --- a/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs +++ b/src/Lucene.Net/Support/Codecs/DefaultCodecFactory.cs @@ -37,9 +37,9 @@ namespace Lucene.Net.Codecs /// <see cref="DefaultCodecFactory.GetCodecType(string)"/> so a type new type can be /// supplied that is not in the <see cref="DefaultCodecFactory.codecNameToTypeMap"/>.</item> /// <item>subclass <see cref="DefaultCodecFactory"/> to add new or override the default <see cref="Codec"/> - /// types by overriding <see cref="Initialize()"/> and calling <see cref="PutPostingsFormatType(Type)"/>.</item> + /// types by overriding <see cref="Initialize()"/> and calling <see cref="PutCodecType(Type)"/>.</item> /// <item>subclass <see cref="DefaultCodecFactory"/> to scan additional assemblies for <see cref="Codec"/> - /// subclasses in by overriding <see cref="Initialize()"/> and calling <see cref="ScanForPostingsFormats(Assembly)"/>. + /// subclasses in by overriding <see cref="Initialize()"/> and calling <see cref="ScanForCodecs(Assembly)"/>. /// For performance reasons, the default behavior only loads Lucene.Net codecs.</item> /// </list> /// <para/> http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3e9c4ab0/src/Lucene.Net/Support/Codecs/DefaultDocValuesFormatFactory.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Support/Codecs/DefaultDocValuesFormatFactory.cs b/src/Lucene.Net/Support/Codecs/DefaultDocValuesFormatFactory.cs index d5f0e75..a85d6af 100644 --- a/src/Lucene.Net/Support/Codecs/DefaultDocValuesFormatFactory.cs +++ b/src/Lucene.Net/Support/Codecs/DefaultDocValuesFormatFactory.cs @@ -37,9 +37,9 @@ namespace Lucene.Net.Codecs /// <see cref="DefaultDocValuesFormatFactory.GetDocValuesFormatType(string)"/> so a type new type can be /// supplied that is not in the <see cref="DefaultDocValuesFormatFactory.docValuesFormatNameToTypeMap"/>.</item> /// <item>subclass <see cref="DefaultDocValuesFormatFactory"/> to add new or override the default <see cref="DocValuesFormat"/> - /// types by overriding <see cref="Initialize()"/> and calling <see cref="PutPostingsFormatType(Type)"/>.</item> + /// types by overriding <see cref="Initialize()"/> and calling <see cref="PutDocValuesFormatType(Type)"/>.</item> /// <item>subclass <see cref="DefaultDocValuesFormatFactory"/> to scan additional assemblies for <see cref="DocValuesFormat"/> - /// subclasses in by overriding <see cref="Initialize()"/> and calling <see cref="ScanForPostingsFormats(Assembly)"/>. + /// subclasses in by overriding <see cref="Initialize()"/> and calling <see cref="ScanForDocValuesFormats(Assembly)"/>. /// For performance reasons, the default behavior only loads Lucene.Net codecs.</item> /// </list> /// <para/> @@ -190,7 +190,7 @@ namespace Lucene.Net.Codecs /// <summary> /// Gets a list of the available <see cref="DocValuesFormat"/>s (by name). /// </summary> - /// <returns>A <see cref="ICollection{string}"/> of <see cref="DocValuesFormat"/> names.</returns> + /// <returns>A <see cref="T:ICollection{string}"/> of <see cref="DocValuesFormat"/> names.</returns> public virtual ICollection<string> AvailableServices() { EnsureInitialized(); http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3e9c4ab0/src/Lucene.Net/Support/Codecs/DefaultPostingsFormatFactory.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Support/Codecs/DefaultPostingsFormatFactory.cs b/src/Lucene.Net/Support/Codecs/DefaultPostingsFormatFactory.cs index c1a3982..0cbd907 100644 --- a/src/Lucene.Net/Support/Codecs/DefaultPostingsFormatFactory.cs +++ b/src/Lucene.Net/Support/Codecs/DefaultPostingsFormatFactory.cs @@ -32,7 +32,7 @@ namespace Lucene.Net.Codecs /// <see cref="DefaultPostingsFormatFactory.GetPostingsFormat(Type)"/> so an external dependency injection /// container can be used to supply the instances (lifetime should be singleton). Note that you could /// alternately use the "named type" feature that many DI containers have to supply the type based on name by - /// overriding <see cref="GetDocValuesFormat(string)"/>.</item> + /// overriding <see cref="GetPostingsFormat(string)"/>.</item> /// <item>subclass <see cref="DefaultPostingsFormatFactory"/> and override /// <see cref="DefaultPostingsFormatFactory.GetPostingsFormatType(string)"/> so a type new type can be /// supplied that is not in the <see cref="DefaultPostingsFormatFactory.postingsFormatNameToTypeMap"/>.</item> @@ -43,7 +43,7 @@ namespace Lucene.Net.Codecs /// For performance reasons, the default behavior only loads Lucene.Net codecs.</item> /// </list> /// <para/> - /// To set the <see cref="IPostingsFormatFactory"/>, call <see cref="DocValuesFormat.SetPostingsFormatFactory(IPostingsFormatFactory)"/>. + /// To set the <see cref="IPostingsFormatFactory"/>, call <see cref="PostingsFormat.SetPostingsFormatFactory(IPostingsFormatFactory)"/>. /// </summary> public class DefaultPostingsFormatFactory : NamedServiceFactory<PostingsFormat>, IPostingsFormatFactory, IServiceListable { @@ -56,7 +56,7 @@ namespace Lucene.Net.Codecs /// <summary> /// Initializes the codec type cache with the known <see cref="PostingsFormat"/> types. /// Override this method (and optionally call <c>base.Initialize()</c>) to add your - /// own <see cref="PostingsFormat"/> types by calling <see cref="PutDocPostingsFormatType(Type)"/> + /// own <see cref="PostingsFormat"/> types by calling <see cref="PutPostingsFormatType(Type)"/> /// or <see cref="ScanForPostingsFormats(Assembly)"/>. /// <para/> /// If two types have the same name by using the <see cref="PostingsFormatNameAttribute"/>, the @@ -105,7 +105,7 @@ namespace Lucene.Net.Codecs } /// <summary> - /// Adds a <see cref="PostingsFormat"/> type to the <see cref="postingsFormaNameToTypeMap"/>, using + /// Adds a <see cref="PostingsFormat"/> type to the <see cref="postingsFormatNameToTypeMap"/>, using /// the name provided in the <see cref="PostingsFormatNameAttribute"/>, if present, or the name /// of the codec class minus the "Codec" suffix as the name by default. /// <para/> @@ -190,7 +190,7 @@ namespace Lucene.Net.Codecs /// <summary> /// Gets a list of the available <see cref="PostingsFormat"/>s (by name). /// </summary> - /// <returns>A <see cref="ICollection{string}"/> of <see cref="PostingsFormat"/> names.</returns> + /// <returns>A <see cref="T:ICollection{string}"/> of <see cref="PostingsFormat"/> names.</returns> public virtual ICollection<string> AvailableServices() { EnsureInitialized(); http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3e9c4ab0/src/Lucene.Net/Support/Util/ExcludeServiceAttribute.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Support/Util/ExcludeServiceAttribute.cs b/src/Lucene.Net/Support/Util/ExcludeServiceAttribute.cs index be6c4d0..5ad547b 100644 --- a/src/Lucene.Net/Support/Util/ExcludeServiceAttribute.cs +++ b/src/Lucene.Net/Support/Util/ExcludeServiceAttribute.cs @@ -17,6 +17,9 @@ * limitations under the License. */ + /// <summary> + /// Base class for <see cref="Attribute"/> types that exclude services from Reflection scanning. + /// </summary> public abstract class ExcludeServiceAttribute : System.Attribute { } http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3e9c4ab0/src/Lucene.Net/Support/Util/IServiceListable.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Support/Util/IServiceListable.cs b/src/Lucene.Net/Support/Util/IServiceListable.cs index f139600..a9d80a8 100644 --- a/src/Lucene.Net/Support/Util/IServiceListable.cs +++ b/src/Lucene.Net/Support/Util/IServiceListable.cs @@ -31,6 +31,10 @@ namespace Lucene.Net.Util /// </summary> public interface IServiceListable { + /// <summary> + /// Lists the available services for the current service type. + /// </summary> + /// <returns></returns> ICollection<string> AvailableServices(); } } http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3e9c4ab0/src/Lucene.Net/Support/Util/ServiceNameAttribute.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Support/Util/ServiceNameAttribute.cs b/src/Lucene.Net/Support/Util/ServiceNameAttribute.cs index 1f8c87a..503d762 100644 --- a/src/Lucene.Net/Support/Util/ServiceNameAttribute.cs +++ b/src/Lucene.Net/Support/Util/ServiceNameAttribute.cs @@ -27,6 +27,10 @@ namespace Lucene.Net.Util /// </summary> public abstract class ServiceNameAttribute : System.Attribute { + /// <summary> + /// Sole constructor. Initializes the service name. + /// </summary> + /// <param name="name"></param> public ServiceNameAttribute(string name) { if (string.IsNullOrEmpty(name)) @@ -34,6 +38,9 @@ namespace Lucene.Net.Util this.Name = name; } + /// <summary> + /// Gets the service name. + /// </summary> public string Name { get; private set; } } }
