2013-02-18 10 views
3

Я пытаюсь написать Javadoc, который отображает Javadoc из другого метода, например:Как связать JavaDoc с другим классом?

private List<Object> list; 

/** 
* {@link list#indexOf(Object)} 
*/ 
int getMyIndex(Object o) { 
    return list.indexOf(o); 
} 

Это дало бы мне ссылку JavaDoc, когда я использую мой getMyIndex() метод. Но я хочу, чтобы затмение фактически показывало (!) Javadoc из метода, на который я ссылался в @link.

Конечно, это не какая ссылка. Ссылка делает то, что должно делать в этом случае.

Но что мне нужно использовать, чтобы каким-то образом «импортировать» иностранный javadoc?

+0

Я не думаю, что так ... ближе всего находится {@inheritDoc}, но это для «импортирования» главное описание родительского метода. –

+0

Да, я тоже подумал об этом, но, как вы сказали, подходит только в том случае, если класс расширяет другой. – membersound

ответ

8

Нет таких тегов или функциональных возможностей, насколько я знаю. См. javadoc tag list for more details.

Из ссылки

 
    Tag  | Introduced in JDK/SDK 
----------------------------------- 
    @author  1.0 
    {@code}  1.5 
    {@docRoot} 1.3 
    @deprecated 1.0 
    @exception 1.0 
    {@inheritDoc} 1.4 
    {@link}  1.2 
    {@linkplain} 1.4 
    {@literal} 1.5 
    @param  1.0 
    @return  1.0 
    @see   1.0 
    @serial  1.2 
    @serialData 1.2 
    @serialField 1.2 
    @since  1.1 
    @throws  1.2 
    {@value}  1.4 
    @version  1.0 
Смежные вопросы