Как использовать разные URL для каждого класса в сгенерированной документации API? - PullRequest
0 голосов
/ 16 мая 2019

Я разместил сгенерированную документацию по API моего проекта на страницах Github, что очень приятно и просто.Однако я также хотел бы дать ссылку на документацию по конкретным классам с моего сайта.Я заметил, что реализация по умолчанию имеет одинаковый URL для всей документации, что делает невозможным ссылку на что-то конкретное.

В качестве примера рассмотрим Документы Google Guava API .Независимо от того, сколько вы нажимаете, URL остается неизменным.Это делает невозможным ссылку на, скажем, класс Lists.Это возможно сделать, либо с помощью опции в javadocs, либо на страницах Github?

1 Ответ

1 голос
/ 17 мая 2019

Нажмите на кнопку No Frames чуть ниже верхней панели. В этом режиме ваш URL будет меняться в зависимости от страницы, которую вы посещаете. Затем вы можете скопировать эту ссылку и включить ее в свои собственные документы. (https://google.github.io/guava/releases/snapshot-jre/api/docs/com/google/common/collect/Lists.html).

Оказавшись на странице, вы также можете вернуться в режим фреймов, а после docs/ в URL-адресе все станет строкой запроса. Для ссылки, я думаю, предпочтительнее использовать ссылку без фреймов.

...