JavaDocs - добавление гиперссылки к каждому разделу и включение тега скрипта для каждого HTML-файла. - PullRequest
Новая
       34

JavaDocs - добавление гиперссылки к каждому разделу и включение тега скрипта для каждого HTML-файла.

0 голосов
/ 18 февраля 2019

Поэтому я использую этот плагин для генерации javadocs: 

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-source-plugin</artifactId>
    <version>3.0.1</version>
    <executions>
        <execution>
            <id>attach-sources</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

и для генерации документов, которые я использую: mvn javadoc:javadoc

, и я получаю что-то вроде этого:

enter image description here

У меня два вопроса:

  1. Есть ли способ поставить <a>или <div> в разделах HTML, чтобы я мог гиперссылку на него с помощью этой техники?https://stackoverflow.com/a/2835151/1223975

  2. Мне нужно включить тег javascript в каждый html-файл для сгенерированных javadocs.Есть ли способ сказать плагину включить этот тег сценария в каждый HTML-файл?В <head>?Или действительно где угодно, так как это для стиля.

Например, чтобы решить # 2, я попытался добавить это выше каждого класса в моем проекте: 

/*
 * <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>
 **/
public class Foo {}

, но этопохоже, не работает, тег script не добавляется в html.

Ответы [ 2 ]

0 голосов
/ 18 февраля 2019

Я понял # 2, поэтому мой синтаксис был неправильным, вместо этого: 

/*
 * <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>
 **/
public class Foo {}

должно быть: 

/**
 * <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>
 */
public class Foo {}

, тогда он загрузит скрипт на любую страницуJavadocs вы находитесь.

0 голосов
/ 18 февраля 2019

Чтобы решить # 2, я просто взломал.Я скопировал исходный код из библиотеки google-code-prettify в общий файл .js, который уже загружен страницами javadoc.

https://rawgit.com/google/code-prettify/master/loader/run_prettify.js

Я скопировал приведенный выше код по ссылке вфайл .js в target/site/apidocs/script.js.Это не очень хорошее решение, если формат javadoc изменится, но пока будет работать.Я бы предпочел иметь возможность декларативно загружать теги <script> по желанию в моих комментариях Javadoc, если это возможно.

...