Repository: lucenenet Updated Branches: refs/heads/master 33abcb79e -> 6c5e2217d
Updated documentation of Codec, DocValuesFormat, and PostingsFormat to account for the new initialization procedure of the codec factories. Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/6c5e2217 Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/6c5e2217 Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/6c5e2217 Branch: refs/heads/master Commit: 6c5e2217d41148334573cdc495f91b87820634ba Parents: 33abcb7 Author: Shad Storhaug <[email protected]> Authored: Thu May 18 21:01:32 2017 +0700 Committer: Shad Storhaug <[email protected]> Committed: Thu May 18 21:01:32 2017 +0700 ---------------------------------------------------------------------- src/Lucene.Net/Codecs/Codec.cs | 6 +++--- src/Lucene.Net/Codecs/DocValuesFormat.cs | 6 +++--- src/Lucene.Net/Codecs/PostingsFormat.cs | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6c5e2217/src/Lucene.Net/Codecs/Codec.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/Codec.cs b/src/Lucene.Net/Codecs/Codec.cs index 816547c..e70cd5e 100644 --- a/src/Lucene.Net/Codecs/Codec.cs +++ b/src/Lucene.Net/Codecs/Codec.cs @@ -32,9 +32,9 @@ namespace Lucene.Net.Codecs /// To implement your own codec: /// <list type="number"> /// <item>Subclass this class.</item> - /// <item>Subclass <see cref="DefaultCodecFactory"/> and add the line - /// <c>base.ScanForCodecs(typeof(YourCodec).GetTypeInfo().Assembly)</c> - /// to the constructor. If you have any codec classes in your assembly + /// <item>Subclass <see cref="DefaultCodecFactory"/>, override the <see cref="DefaultCodecFactory.Initialize()"/> method, + /// and add the line <c>base.ScanForCodecs(typeof(YourCodec).GetTypeInfo().Assembly)</c>. + /// If you have any codec classes in your assembly /// that are not meant for reading, you can add the <see cref="ExcludeCodecFromScanAttribute"/> /// to them so they are ignored by the scan.</item> /// <item>set the new <see cref="ICodecFactory"/> by calling <see cref="SetCodecFactory"/> at application startup.</item> http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6c5e2217/src/Lucene.Net/Codecs/DocValuesFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/DocValuesFormat.cs b/src/Lucene.Net/Codecs/DocValuesFormat.cs index e6f127d..813d9a1 100644 --- a/src/Lucene.Net/Codecs/DocValuesFormat.cs +++ b/src/Lucene.Net/Codecs/DocValuesFormat.cs @@ -35,9 +35,9 @@ namespace Lucene.Net.Codecs /// To implement your own format: /// <list type="number"> /// <item>Subclass this class.</item> - /// <item>Subclass <see cref="DefaultDocValuesFormatFactory"/> and add the line - /// <c>base.ScanForDocValuesFormats(typeof(YourDocValuesFormat).GetTypeInfo().Assembly)</c> - /// to the constructor. If you have any format classes in your assembly + /// <item>Subclass <see cref="DefaultDocValuesFormatFactory"/>, override the <see cref="DefaultDocValuesFormatFactory.Initialize()"/> method, + /// and add the line <c>base.ScanForDocValuesFormats(typeof(YourDocValuesFormat).GetTypeInfo().Assembly)</c>. + /// If you have any format classes in your assembly /// that are not meant for reading, you can add the <see cref="ExcludeDocValuesFormatFromScanAttribute"/> /// to them so they are ignored by the scan.</item> /// <item>Set the new <see cref="IDocValuesFormatFactory"/> by calling <see cref="SetDocValuesFormatFactory(IDocValuesFormatFactory)"/> http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6c5e2217/src/Lucene.Net/Codecs/PostingsFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/PostingsFormat.cs b/src/Lucene.Net/Codecs/PostingsFormat.cs index c4bdd88..2a74ea6 100644 --- a/src/Lucene.Net/Codecs/PostingsFormat.cs +++ b/src/Lucene.Net/Codecs/PostingsFormat.cs @@ -33,9 +33,9 @@ namespace Lucene.Net.Codecs /// If you implement your own format: /// <list type="number"> /// <item>Subclass this class.</item> - /// <item>Subclass <see cref="DefaultPostingsFormatFactory"/> and add the line - /// <c>base.ScanForPostingsFormats(typeof(YourPostingsFormat).GetTypeInfo().Assembly)</c> - /// to the constructor. If you have any format classes in your assembly + /// <item>Subclass <see cref="DefaultPostingsFormatFactory"/>, override <see cref="DefaultPostingsFormatFactory.Initialize()"/>, + /// and add the line <c>base.ScanForPostingsFormats(typeof(YourPostingsFormat).GetTypeInfo().Assembly)</c>. + /// If you have any format classes in your assembly /// that are not meant for reading, you can add the <see cref="ExcludePostingsFormatFromScanAttribute"/> /// to them so they are ignored by the scan.</item> /// <item>Set the new <see cref="IPostingsFormatFactory"/> by calling <see cref="SetPostingsFormatFactory(IPostingsFormatFactory)"/>
