Я пытаюсь создать документацию для библиотеки Groovy, используя Intellij (2109.3.3) со сборкой Gradle, используя задачу groovydo c в окне Gradle.
Структура библиотеки следующим образом:
Используемый компонент (AnyGroupOfPipelineCollects) является лишь одним примером, поскольку ни один из тегов {@link} не работает ни в одной документации Я создал.
Начало класса выглядит следующим образом:
package GPP_Library.functionals.composites
import GPP_Library.CompositeDetails
import GPP_Library.ResultDetails
import GPP_Library.functionals.pipelines.OnePipelineCollect
import groovy.transform.CompileStatic
import groovyJCSP.PAR
import jcsp.lang.CSProcess
import jcsp.lang.ChannelInput
import jcsp.lang.ChannelOutput
/**
* An AnyGroupOfPipelineCollects comprises a network of {@code groups} parallel occurrences and each pipeline comprises
* {@code stages} Worker processes, excluding the final {@link GPP_Library.terminals.Collect Collect} stage.
* Inputs from the preceding process are assumed to come from the any end of a channel.
* Internally, a collection of
* {@code groups} {@link GPP_Library.functionals.pipelines.OnePipelineCollect OnePipeLineCollect} pipelines are created.
*
После выполнения задачи Gradle groovydo c построенная документация выглядит следующим образом:
AnyGroupOfPipelineCollects включает в себя сеть из групп параллельных вхождений, и каждый конвейер содержит этапов рабочих процессов, исключая последний этап GPP_Library.terminals.Collect. Предполагается, что входы из предыдущего процесса поступают с любого конца канала. Внутри создается коллекция групп GPP_Library.functionals.pipelines.OnePipelineCollect конвейеров.
Как видно, ожидаемое преобразование ссылок в Collect и OnePipelineCollect в виде гипертекстовых терминов не произошло, хотя теги {@code} были обработаны правильно.
Кроме того, как единое целое вводит элемент link package.class, Intellij распознает неправильные формулировки, пока они не будут правильными.
Я понял, что имя библиотеки не соответствует Java соглашениям об именах, поэтому изменил его на другое имя, но это имело не влияет на сгенерированную документацию.