[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
[recommenders-dev] [GSOC 2013] LiveDoc Weekly Report
|
Hi,
here is my update for this week:
What I had planned for this week:
- Get familiar with the new o.e.r headless api
- Implement a first version of an Overrides Taglet (actually for
packages)
What I have done this week:
- Got a first impression + usage of the headless api
- Use aether to resolve models of o.e.r. repositories (which is a
'for the moment' solution)
- Mine some models on myself, because i can't resolve maven central
artifacts against the kepler models repository
- Wrote a first version of an Overrides Taglet (for classes only)
What I have planned for the next week:
- Some major refactorings are now really necessary on my core
classes, debugging gets worse. A part of this is my debt, the other
side is I didn't planned to use aether on a second plug-in (and
therefor re-need groupId, artifactId, etc.)
- pretty print the output of the overrides taglet for classes
- Write an overrides taglet (or extend the existing one) for
packages
The code for the Overrides Taglet is on
https://github.com/philomatic/recommenders-jdoc/tree/overrides
CAVEAT: It's a draft commit, which will be force pushed in the next
few days, so don't rely on the git history.
For using this code, you'll need a m2 source code repository and an
appropriate (with fitting maven coordinates) m2 models repository.
(@Marcel: Am I allowed to publish my own mined repository to this
mailing list?)
Example cmd line arguments:
org.apache.lucene:org.apache.lucene.core:3.5.0 -sr
C:\Users\PaddyG\Code\m2_eclipse-modeling-kepler_source -mr
C:\Users\PaddyG\Code\m2_eclipse-modeling-kepler_models\models -d
C:\Users\PaddyG\Code\LiveDocOutput
-sr: source code repo
-mr: models repo
-d output directory
The generated output is pretty 'basic' atm, but you'll get an idea
of the finished version:
Overrides class documentation:
- Lorg/apache/lucene/analysis/Analyzer.tokenStream(Ljava/lang/String;Ljava/io/Reader;)Lorg/apache/lucene/analysis/TokenStream;
- 70%
For those of you who are too lazy to check-out code and get it
running, see this site with generated HTML Documentation for
org.apache.lucene.core:
http://livedoc.gottschaemmer.net
Attached is a list with classes in lucene-core, which are documented
with overrides statistics.
Best regards
Patrick
(Who will cycle now 250km in two days, wish him good luck!)
|
Lorg/apache/lucene/analysis/Analyzer
Lorg/apache/lucene/analysis/BaseCharFilter
Lorg/apache/lucene/analysis/CharArrayMap
Lorg/apache/lucene/analysis/CharArrayMap$UnmodifiableCharArrayMap
Lorg/apache/lucene/analysis/CharArraySet
Lorg/apache/lucene/analysis/CharFilter
Lorg/apache/lucene/analysis/CharStream
Lorg/apache/lucene/analysis/CharTokenizer
Lorg/apache/lucene/analysis/FilteringTokenFilter
Lorg/apache/lucene/analysis/LetterTokenizer
Lorg/apache/lucene/analysis/ReusableAnalyzerBase
Lorg/apache/lucene/analysis/ReusableAnalyzerBase$TokenStreamComponents
Lorg/apache/lucene/analysis/StopwordAnalyzerBase
Lorg/apache/lucene/analysis/TeeSinkTokenFilter$SinkFilter
Lorg/apache/lucene/analysis/TokenFilter
Lorg/apache/lucene/analysis/TokenStream
Lorg/apache/lucene/analysis/Tokenizer
Lorg/apache/lucene/analysis/tokenattributes/CharTermAttributeImpl
Lorg/apache/lucene/analysis/tokenattributes/TermAttributeImpl
Lorg/apache/lucene/document/AbstractField
Lorg/apache/lucene/document/Field$Index
Lorg/apache/lucene/document/Field$Store
Lorg/apache/lucene/document/Field$TermVector
Lorg/apache/lucene/index/AbstractAllTermDocs
Lorg/apache/lucene/index/ByteBlockPool$Allocator
Lorg/apache/lucene/index/ConcurrentMergeScheduler
Lorg/apache/lucene/index/CorruptIndexException
Lorg/apache/lucene/index/DirectoryReader
Lorg/apache/lucene/index/DirectoryReader$MultiTermDocs
Lorg/apache/lucene/index/DocConsumer
Lorg/apache/lucene/index/DocConsumerPerThread
Lorg/apache/lucene/index/DocFieldConsumer
Lorg/apache/lucene/index/DocFieldConsumerPerField
Lorg/apache/lucene/index/DocFieldConsumerPerThread
Lorg/apache/lucene/index/DocumentsWriter$DocWriter
Lorg/apache/lucene/index/DocumentsWriter$IndexingChain
Lorg/apache/lucene/index/FilterIndexReader$FilterTermDocs
Lorg/apache/lucene/index/FormatPostingsDocsConsumer
Lorg/apache/lucene/index/FormatPostingsFieldsConsumer
Lorg/apache/lucene/index/FormatPostingsPositionsConsumer
Lorg/apache/lucene/index/FormatPostingsTermsConsumer
Lorg/apache/lucene/index/IndexCommit
Lorg/apache/lucene/index/IndexReader
Lorg/apache/lucene/index/IndexWriter$IndexReaderWarmer
Lorg/apache/lucene/index/InvertedDocConsumer
Lorg/apache/lucene/index/InvertedDocConsumerPerField
Lorg/apache/lucene/index/InvertedDocConsumerPerThread
Lorg/apache/lucene/index/InvertedDocEndConsumer
Lorg/apache/lucene/index/InvertedDocEndConsumerPerField
Lorg/apache/lucene/index/InvertedDocEndConsumerPerThread
Lorg/apache/lucene/index/LogMergePolicy
Lorg/apache/lucene/index/MergePolicy
Lorg/apache/lucene/index/MergeScheduler
Lorg/apache/lucene/index/MultiLevelSkipListReader
Lorg/apache/lucene/index/MultiLevelSkipListWriter
Lorg/apache/lucene/index/ParallelPostingsArray
Lorg/apache/lucene/index/ParallelReader$ParallelTermDocs
Lorg/apache/lucene/index/SegmentInfos$FindSegmentsFile
Lorg/apache/lucene/index/SegmentMerger$CheckAbort
Lorg/apache/lucene/index/SegmentReader
Lorg/apache/lucene/index/SegmentTermDocs
Lorg/apache/lucene/index/SegmentTermVector
Lorg/apache/lucene/index/SnapshotDeletionPolicy
Lorg/apache/lucene/index/TermEnum
Lorg/apache/lucene/index/TermInfo
Lorg/apache/lucene/index/TermVectorMapper
Lorg/apache/lucene/index/TermsHashConsumer
Lorg/apache/lucene/index/TermsHashConsumerPerField
Lorg/apache/lucene/index/TermsHashConsumerPerThread
Lorg/apache/lucene/index/TieredMergePolicy$MergeScore
Lorg/apache/lucene/queryParser/QueryParser
Lorg/apache/lucene/search/BooleanClause$Occur
Lorg/apache/lucene/search/CachingCollector
Lorg/apache/lucene/search/CachingWrapperFilter$FilterCache
Lorg/apache/lucene/search/Collector
Lorg/apache/lucene/search/ConjunctionScorer
Lorg/apache/lucene/search/ConstantScoreAutoRewrite
Lorg/apache/lucene/search/DisjunctionSumScorer
Lorg/apache/lucene/search/DocIdSet
Lorg/apache/lucene/search/DocIdSetIterator
Lorg/apache/lucene/search/Explanation
Lorg/apache/lucene/search/Explanation$IDFExplanation
Lorg/apache/lucene/search/FieldCache$CacheEntry
Lorg/apache/lucene/search/FieldCacheImpl$Cache
Lorg/apache/lucene/search/FieldCacheRangeFilter
Lorg/apache/lucene/search/FieldCacheRangeFilter$FieldCacheDocIdSet
Lorg/apache/lucene/search/FieldComparator
Lorg/apache/lucene/search/FieldComparator$NumericComparator
Lorg/apache/lucene/search/FieldValueHitQueue
Lorg/apache/lucene/search/Filter
Lorg/apache/lucene/search/FilteredDocIdSet
Lorg/apache/lucene/search/FilteredDocIdSetIterator
Lorg/apache/lucene/search/FilteredTermEnum
Lorg/apache/lucene/search/MultiSearcher
Lorg/apache/lucene/search/MultiTermQuery
Lorg/apache/lucene/search/MultiTermQuery$ConstantScoreAutoRewrite
Lorg/apache/lucene/search/MultiTermQuery$RewriteMethod
Lorg/apache/lucene/search/MultiTermQueryWrapperFilter
Lorg/apache/lucene/search/PhraseQuery
Lorg/apache/lucene/search/PhraseScorer
Lorg/apache/lucene/search/Query
Lorg/apache/lucene/search/ScoreDoc
Lorg/apache/lucene/search/Scorer
Lorg/apache/lucene/search/ScoringRewrite
Lorg/apache/lucene/search/Searcher
Lorg/apache/lucene/search/Similarity
Lorg/apache/lucene/search/SpanFilter
Lorg/apache/lucene/search/TermCollectingRewrite
Lorg/apache/lucene/search/TopDocs
Lorg/apache/lucene/search/TopFieldCollector
Lorg/apache/lucene/search/TopFieldCollector$MultiComparatorNonScoringCollector
Lorg/apache/lucene/search/TopFieldCollector$MultiComparatorScoringMaxScoreCollector
Lorg/apache/lucene/search/TopFieldCollector$MultiComparatorScoringNoMaxScoreCollector
Lorg/apache/lucene/search/TopFieldCollector$OneComparatorNonScoringCollector
Lorg/apache/lucene/search/TopFieldCollector$OneComparatorScoringMaxScoreCollector
Lorg/apache/lucene/search/TopFieldCollector$OneComparatorScoringNoMaxScoreCollector
Lorg/apache/lucene/search/TopScoreDocCollector
Lorg/apache/lucene/search/TopTermsRewrite
Lorg/apache/lucene/search/Weight
Lorg/apache/lucene/search/function/DocValues
Lorg/apache/lucene/search/function/FieldCacheSource
Lorg/apache/lucene/search/function/ValueSource
Lorg/apache/lucene/search/function/ValueSourceQuery
Lorg/apache/lucene/search/payloads/PayloadFunction
Lorg/apache/lucene/search/spans/SpanMultiTermQueryWrapper$SpanRewriteMethod
Lorg/apache/lucene/search/spans/SpanNearQuery
Lorg/apache/lucene/search/spans/SpanPositionCheckQuery
Lorg/apache/lucene/search/spans/SpanPositionRangeQuery
Lorg/apache/lucene/search/spans/SpanQuery
Lorg/apache/lucene/search/spans/SpanScorer
Lorg/apache/lucene/search/spans/SpanTermQuery
Lorg/apache/lucene/search/spans/SpanWeight
Lorg/apache/lucene/search/spans/Spans
Lorg/apache/lucene/store/BufferedIndexInput
Lorg/apache/lucene/store/BufferedIndexOutput
Lorg/apache/lucene/store/DataInput
Lorg/apache/lucene/store/DataOutput
Lorg/apache/lucene/store/Directory
Lorg/apache/lucene/store/FSDirectory
Lorg/apache/lucene/store/FSLockFactory
Lorg/apache/lucene/store/IndexInput
Lorg/apache/lucene/store/IndexOutput
Lorg/apache/lucene/store/Lock
Lorg/apache/lucene/store/LockFactory
Lorg/apache/lucene/store/RAMFile
Lorg/apache/lucene/store/SimpleFSDirectory$SimpleFSIndexInput
Lorg/apache/lucene/util/AttributeImpl
Lorg/apache/lucene/util/AttributeSource
Lorg/apache/lucene/util/AttributeSource$AttributeFactory
Lorg/apache/lucene/util/ByteBlockPool$Allocator
Lorg/apache/lucene/util/BytesRefHash$BytesStartArray
Lorg/apache/lucene/util/CharacterUtils
Lorg/apache/lucene/util/CloseableThreadLocal
Lorg/apache/lucene/util/Counter
Lorg/apache/lucene/util/DoubleBarrelLRUCache$CloneableKey
Lorg/apache/lucene/util/MemoryModel
Lorg/apache/lucene/util/NumericUtils$IntRangeBuilder
Lorg/apache/lucene/util/NumericUtils$LongRangeBuilder
Lorg/apache/lucene/util/OpenBitSet
Lorg/apache/lucene/util/PriorityQueue
Lorg/apache/lucene/util/ReaderUtil$Gather
Lorg/apache/lucene/util/SorterTemplate
Lorg/apache/lucene/util/StringInterner
Lorg/apache/lucene/util/fst/FSTEnum
Lorg/apache/lucene/util/fst/Outputs
Lorg/apache/lucene/util/packed/PackedInts$ReaderImpl
Lorg/apache/lucene/util/packed/PackedInts$Writer