search

hobama / dkpro-wsd

Automatically exported from code.google.com/p/dkpro-wsd
0 stars 0 forks source link

Documentation for Nico's classes #15

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
The following classes need documentation.  I think most or all of them were 
written by Nico:

WSDAlgorithmDocumentBasic
WSDAlgorithmDocumentDependentBasic
WSDAlgorithmDocumentTextBasic
WSDResourceStringList
SenseWeightedInventory
WSDAnnotatorStringList
RandomSequentialDisambiguation
SequentialGraphDisambiguation
DisambiguationEdge
DisambiguationEdgeTransformer
DisambiguationVertex
DisambiguationVertexTransformer
LinkInformationSequentialDisambiguation
LinkMeasureSequentialDisambiguation
IncomingLinksCache
SimilarityCache
WikipediaCommonnessMethod
WikipediaRelatednessMethod
GoogleDictionaryInventory
IDocumentDependentDictionary
IGoogleDictionary
IUkbDictionary
UkbDictionaryInventory
UkbDocumentDependentDictionaryInventory
GoogleDictionaryInventoryResource
UkbDictionaryInventoryResource
AbstractDictionary
Dictionary
DictionaryWithoutFrequencies
LinkDatabase
LinkDatabaseInventory
LinkDatabaseInventoryResource
MySqlConnection
PerformanceLinkInformationReader
PerformanceLinkInformationWriter
Linkidentification
LinkIdentificationUtils
LinkInformationSequentialDisambiguation
MapUtil
TwsiWsdDisambiguator
TacKbpDocument
TacKbpDocumentCreator
TacKbpOfficialFormatReader

At minimum there should be a one- or two-line comment at the top of the class 
explaining what it's for.

Original issue reported on code.google.com by tristan.miller@nothingisreal.com on 11 Jul 2013 at 4:12

GoogleCodeExporter commented 9 years ago

Original comment by tristan.miller@nothingisreal.com on 11 Jul 2013 at 4:12

GoogleCodeExporter commented 9 years ago

Original comment by tristan.miller@nothingisreal.com on 12 Jul 2013 at 4:14

GoogleCodeExporter commented 9 years ago 
I added the minimum to all classes and for some classes I added extensive 
documentation.

Original comment by nico.erbs@gmail.com on 15 Jul 2013 at 3:39