Skip to content

Commit

Permalink
renaming docProcessor package to kodex
Browse files Browse the repository at this point in the history
  • Loading branch information
Jolanrensen committed Jan 2, 2025
1 parent ea2e4b7 commit 9d9767c
Show file tree
Hide file tree
Showing 90 changed files with 452 additions and 448 deletions.
116 changes: 60 additions & 56 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion kodex-common/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ plugins {
id("org.jlleitschuh.gradle.ktlint")
}

group = "nl.jolanrensen.docProcessor"
group = "nl.jolanrensen.kodex"
version = "0.4.0-SNAPSHOT"

repositories {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

data class AnnotationWrapper(val fullyQualifiedPath: String, val arguments: List<Pair<String?, Any?>>) {
override fun toString(): String =
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

/**
* Completion info for a tag. Shows up in the completion popup.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

/**
* Same as [DocProcessor] but without the ability to modify docs.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

import io.github.oshai.kotlinlogging.KLogger
import io.github.oshai.kotlinlogging.KotlinLogging
Expand All @@ -9,7 +9,7 @@ import java.util.ServiceLoader
* Abstract class that can be used to create a doc processor.
*
* Make sure to add the fully qualified name of your class to your
* (`resources/META-INF/services/nl.jolanrensen.docProcessor.DocProcessor`)
* (`resources/META-INF/services/nl.jolanrensen.kodex.DocProcessor`)
* to make it visible to the service loader in [ProcessDocsAction].
*
* @see TagDocProcessor
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

/**
* Exception that is thrown when a [DocProcessor] fails.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

import nl.jolanrensen.docProcessor.ReferenceState.INSIDE_ALIASED_REFERENCE
import nl.jolanrensen.docProcessor.ReferenceState.INSIDE_REFERENCE
import nl.jolanrensen.docProcessor.ReferenceState.NONE
import nl.jolanrensen.kodex.ReferenceState.INSIDE_ALIASED_REFERENCE
import nl.jolanrensen.kodex.ReferenceState.INSIDE_REFERENCE
import nl.jolanrensen.kodex.ReferenceState.NONE
import java.util.SortedMap
import kotlin.collections.ArrayDeque

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

import nl.jolanrensen.docProcessor.DocumentableWrapper.Companion
import nl.jolanrensen.docProcessor.ProgrammingLanguage.JAVA
import nl.jolanrensen.kodex.DocumentableWrapper.Companion
import nl.jolanrensen.kodex.ProgrammingLanguage.JAVA
import java.io.File
import java.util.UUID

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

import java.util.UUID

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

open class DocumentablesByPathFromMap(
private val allDocs: Map<String, List<DocumentableWrapper>>,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

import nl.jolanrensen.docProcessor.defaultProcessors.IncludeDocAnalyzer
import nl.jolanrensen.kodex.defaultProcessors.IncludeDocAnalyzer
import org.jgrapht.graph.SimpleDirectedGraph
import org.jgrapht.traverse.BreadthFirstIterator
import org.jgrapht.traverse.TopologicalOrderIterator
Expand Down Expand Up @@ -51,7 +51,7 @@ open class DocumentablesByPathWithCache(
fun getDocContentResult(docId: UUID): DocContent? = docContentResultCache[docId]

/**
* called from [nl.jolanrensen.docProcessor.services.PostIncludeDocProcessorCacheCollector]
* called from [nl.jolanrensen.kodex.services.PostIncludeDocProcessorCacheCollector]
*/
fun updatePostIncludeDocContentResult(documentable: DocumentableWrapper) {
postIncludeDocContentCache[documentable.identifier] = documentable.docContent
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

import org.jgrapht.graph.DefaultEdge

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

import kotlin.annotation.AnnotationTarget.ANNOTATION_CLASS
import kotlin.annotation.AnnotationTarget.CLASS
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

import nl.jolanrensen.docProcessor.defaultProcessors.ExportAsHtmlDocProcessor
import nl.jolanrensen.kodex.defaultProcessors.ExportAsHtmlDocProcessor
import kotlin.annotation.AnnotationTarget.ANNOTATION_CLASS
import kotlin.annotation.AnnotationTarget.CLASS
import kotlin.annotation.AnnotationTarget.CONSTRUCTOR
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

/**
* Represents a single highlight in a KDoc.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

import org.intellij.lang.annotations.Language
import org.intellij.markdown.MarkdownElementTypes
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

import java.io.File
import java.util.UUID
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

enum class ProgrammingLanguage {
KOTLIN,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

/**
* Unsafe and simple mirror of
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

/**
* Last index of not [char] moving from startIndex down to 0.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

/**
* Version of TagDocProcessor which does not modify any tags,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

import kotlinx.coroutines.async
import kotlinx.coroutines.awaitAll
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package nl.jolanrensen.docProcessor
package nl.jolanrensen.kodex

/**
* This exception is thrown when a [TagDocProcessor] fails to process a tag.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
package nl.jolanrensen.docProcessor.defaultProcessors
package nl.jolanrensen.kodex.defaultProcessors

import kotlinx.coroutines.joinAll
import kotlinx.coroutines.launch
import kotlinx.coroutines.runBlocking
import nl.jolanrensen.docProcessor.BACKTICKS
import nl.jolanrensen.docProcessor.CURLY_BRACES
import nl.jolanrensen.docProcessor.CompletionInfo
import nl.jolanrensen.docProcessor.DocContent
import nl.jolanrensen.docProcessor.DocumentableWrapper
import nl.jolanrensen.docProcessor.DocumentablesByPath
import nl.jolanrensen.docProcessor.HighlightInfo
import nl.jolanrensen.docProcessor.HighlightType
import nl.jolanrensen.docProcessor.ProgrammingLanguage.JAVA
import nl.jolanrensen.docProcessor.SQUARE_BRACKETS
import nl.jolanrensen.docProcessor.TagDocProcessor
import nl.jolanrensen.docProcessor.asDocContent
import nl.jolanrensen.docProcessor.decodeCallableTarget
import nl.jolanrensen.docProcessor.findTagNames
import nl.jolanrensen.docProcessor.getLineAndCharacterOffset
import nl.jolanrensen.docProcessor.getTagArguments
import nl.jolanrensen.docProcessor.getTagNameOrNull
import nl.jolanrensen.docProcessor.javaLinkRegex
import nl.jolanrensen.docProcessor.removeAllElementsFromLast
import nl.jolanrensen.docProcessor.replaceNonOverlappingRanges
import nl.jolanrensen.docProcessor.withoutFilters
import nl.jolanrensen.kodex.BACKTICKS
import nl.jolanrensen.kodex.CURLY_BRACES
import nl.jolanrensen.kodex.CompletionInfo
import nl.jolanrensen.kodex.DocContent
import nl.jolanrensen.kodex.DocumentableWrapper
import nl.jolanrensen.kodex.DocumentablesByPath
import nl.jolanrensen.kodex.HighlightInfo
import nl.jolanrensen.kodex.HighlightType
import nl.jolanrensen.kodex.ProgrammingLanguage.JAVA
import nl.jolanrensen.kodex.SQUARE_BRACKETS
import nl.jolanrensen.kodex.TagDocProcessor
import nl.jolanrensen.kodex.asDocContent
import nl.jolanrensen.kodex.decodeCallableTarget
import nl.jolanrensen.kodex.findTagNames
import nl.jolanrensen.kodex.getLineAndCharacterOffset
import nl.jolanrensen.kodex.getTagArguments
import nl.jolanrensen.kodex.getTagNameOrNull
import nl.jolanrensen.kodex.javaLinkRegex
import nl.jolanrensen.kodex.removeAllElementsFromLast
import nl.jolanrensen.kodex.replaceNonOverlappingRanges
import nl.jolanrensen.kodex.withoutFilters
import java.util.Collections
import java.util.UUID

/**
* @see ArgDocProcessor
*/
const val ARG_DOC_PROCESSOR = "nl.jolanrensen.docProcessor.defaultProcessors.ArgDocProcessor"
const val ARG_DOC_PROCESSOR = "nl.jolanrensen.kodex.defaultProcessors.ArgDocProcessor"

/**
* [Boolean] argument controlling whether to log warnings when an argument is not found.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
package nl.jolanrensen.docProcessor.defaultProcessors
package nl.jolanrensen.kodex.defaultProcessors

import nl.jolanrensen.docProcessor.CompletionInfo
import nl.jolanrensen.docProcessor.DocContent
import nl.jolanrensen.docProcessor.DocumentableWrapper
import nl.jolanrensen.docProcessor.HighlightInfo
import nl.jolanrensen.docProcessor.HighlightType
import nl.jolanrensen.docProcessor.TagDocProcessor
import nl.jolanrensen.kodex.CompletionInfo
import nl.jolanrensen.kodex.DocContent
import nl.jolanrensen.kodex.DocumentableWrapper
import nl.jolanrensen.kodex.HighlightInfo
import nl.jolanrensen.kodex.HighlightType
import nl.jolanrensen.kodex.TagDocProcessor

/**
* @see CommentDocProcessor
*/
const val COMMENT_DOC_PROCESSOR = "nl.jolanrensen.docProcessor.defaultProcessors.CommentDocProcessor"
const val COMMENT_DOC_PROCESSOR = "nl.jolanrensen.kodex.defaultProcessors.CommentDocProcessor"

/**
* Adds `{@comment tags}` that will be removed from the docs upon processing.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package nl.jolanrensen.docProcessor.defaultProcessors
package nl.jolanrensen.kodex.defaultProcessors

import nl.jolanrensen.docProcessor.DocumentableWrapper
import nl.jolanrensen.docProcessor.TagDocProcessor
import nl.jolanrensen.docProcessor.getTagArguments
import nl.jolanrensen.kodex.DocumentableWrapper
import nl.jolanrensen.kodex.TagDocProcessor
import nl.jolanrensen.kodex.getTagArguments

class ExampleDocProcessor : TagDocProcessor() {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
package nl.jolanrensen.docProcessor.defaultProcessors
package nl.jolanrensen.kodex.defaultProcessors

import nl.jolanrensen.docProcessor.CompletionInfo
import nl.jolanrensen.docProcessor.DocumentableWrapper
import nl.jolanrensen.docProcessor.MutableDocumentableWrapper
import nl.jolanrensen.docProcessor.TagDocProcessor
import nl.jolanrensen.docProcessor.getTagNameOrNull
import nl.jolanrensen.kodex.CompletionInfo
import nl.jolanrensen.kodex.DocumentableWrapper
import nl.jolanrensen.kodex.MutableDocumentableWrapper
import nl.jolanrensen.kodex.TagDocProcessor
import nl.jolanrensen.kodex.getTagNameOrNull

/**
* @see ExportAsHtmlDocProcessor
*/
const val EXPORT_AS_HTML_DOC_PROCESSOR = "nl.jolanrensen.docProcessor.defaultProcessors.ExportAsHtmlDocProcessor"
const val EXPORT_AS_HTML_DOC_PROCESSOR = "nl.jolanrensen.kodex.defaultProcessors.ExportAsHtmlDocProcessor"

/**
* Adds `@exportAsHtmlStart` and `@exportAsHtmlEnd` tags that cam
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
package nl.jolanrensen.docProcessor.defaultProcessors

import nl.jolanrensen.docProcessor.DocumentableWrapper
import nl.jolanrensen.docProcessor.DocumentablesByPath
import nl.jolanrensen.docProcessor.Edge
import nl.jolanrensen.docProcessor.TagDocAnalyser
import nl.jolanrensen.docProcessor.decodeCallableTarget
import nl.jolanrensen.docProcessor.getTagArguments
import nl.jolanrensen.docProcessor.withoutFilters
package nl.jolanrensen.kodex.defaultProcessors

import nl.jolanrensen.kodex.DocumentableWrapper
import nl.jolanrensen.kodex.DocumentablesByPath
import nl.jolanrensen.kodex.Edge
import nl.jolanrensen.kodex.TagDocAnalyser
import nl.jolanrensen.kodex.decodeCallableTarget
import nl.jolanrensen.kodex.getTagArguments
import nl.jolanrensen.kodex.withoutFilters
import org.jgrapht.graph.SimpleDirectedGraph
import java.util.Collections
import java.util.UUID
Expand Down
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
package nl.jolanrensen.docProcessor.defaultProcessors
package nl.jolanrensen.kodex.defaultProcessors

import nl.jolanrensen.docProcessor.CompletionInfo
import nl.jolanrensen.docProcessor.DocumentableWrapper
import nl.jolanrensen.docProcessor.DocumentablesByPath
import nl.jolanrensen.docProcessor.ProgrammingLanguage.JAVA
import nl.jolanrensen.docProcessor.ProgrammingLanguage.KOTLIN
import nl.jolanrensen.docProcessor.TagDocProcessor
import nl.jolanrensen.docProcessor.asDocContent
import nl.jolanrensen.docProcessor.asDocTextOrNull
import nl.jolanrensen.docProcessor.decodeCallableTarget
import nl.jolanrensen.docProcessor.getDocContent
import nl.jolanrensen.docProcessor.getTagArguments
import nl.jolanrensen.docProcessor.javaLinkRegex
import nl.jolanrensen.docProcessor.replaceKdocLinks
import nl.jolanrensen.docProcessor.toDocText
import nl.jolanrensen.docProcessor.withoutFilters
import nl.jolanrensen.kodex.CompletionInfo
import nl.jolanrensen.kodex.DocumentableWrapper
import nl.jolanrensen.kodex.DocumentablesByPath
import nl.jolanrensen.kodex.ProgrammingLanguage.JAVA
import nl.jolanrensen.kodex.ProgrammingLanguage.KOTLIN
import nl.jolanrensen.kodex.TagDocProcessor
import nl.jolanrensen.kodex.asDocContent
import nl.jolanrensen.kodex.asDocTextOrNull
import nl.jolanrensen.kodex.decodeCallableTarget
import nl.jolanrensen.kodex.getDocContent
import nl.jolanrensen.kodex.getTagArguments
import nl.jolanrensen.kodex.javaLinkRegex
import nl.jolanrensen.kodex.replaceKdocLinks
import nl.jolanrensen.kodex.toDocText
import nl.jolanrensen.kodex.withoutFilters
import org.apache.commons.text.StringEscapeUtils
import org.jgrapht.traverse.NotDirectedAcyclicGraphException
import org.jgrapht.traverse.TopologicalOrderIterator

/**
* @see IncludeDocProcessor
*/
const val INCLUDE_DOC_PROCESSOR = "nl.jolanrensen.docProcessor.defaultProcessors.IncludeDocProcessor"
const val INCLUDE_DOC_PROCESSOR = "nl.jolanrensen.kodex.defaultProcessors.IncludeDocProcessor"

const val INCLUDE_DOC_PROCESSOR_PRE_SORT = "$INCLUDE_DOC_PROCESSOR.PRE_SORT"

Expand Down
Loading

0 comments on commit 9d9767c

Please sign in to comment.