/** * For the given method, returns the @param tag description for the given parameter from an * overridden method. * * @param method a method * @param paramIndex the index of the parameter * @return the description that replaces the <code>{@inheritDoc}</code> tag, * or <code>null</code> if none could be found */ public CharSequence getInheritedParamDescription(IMethod method, final int paramIndex) { return getInheritedDescription(method, new DescriptionGetter() { @Override public CharSequence getDescription(JavadocContentAccess2 contentAccess) throws JavaModelException { return contentAccess.getInheritedParamDescription(paramIndex); } }); }
/** * For the given method, returns the @param tag description for the given type parameter * from an overridden method. * * @param method a method * @param typeParamIndex the index of the type parameter * @return the description that replaces the <code>{@inheritDoc}</code> tag, or * <code>null</code> if none could be found */ public CharSequence getInheritedTypeParamDescription(IMethod method, final int typeParamIndex) { return getInheritedDescription(method, new DescriptionGetter() { @Override public CharSequence getDescription(JavadocContentAccess2 contentAccess) throws JavaModelException { return contentAccess.getInheritedTypeParamDescription(typeParamIndex); } }); }
/** * For the given method, returns the @param tag description for the given type parameter * from an overridden method. * * @param method a method * @param typeParamIndex the index of the type parameter * @return the description that replaces the <code>{@inheritDoc}</code> tag, or * <code>null</code> if none could be found */ public CharSequence getInheritedTypeParamDescription(IMethod method, final int typeParamIndex) { return getInheritedDescription(method, new DescriptionGetter() { @Override public CharSequence getDescription(JavadocContentAccess2 contentAccess) throws JavaModelException { return contentAccess.getInheritedTypeParamDescription(typeParamIndex); } }); }
/** * For the given method, returns the @throws/@exception tag description for the given * exception from an overridden method. * * @param method a method * @param simpleName the simple name of an exception * @return the description that replaces the <code>{@inheritDoc}</code> tag, * or <code>null</code> if none could be found */ public CharSequence getInheritedExceptionDescription(IMethod method, final String simpleName) { return getInheritedDescription(method, new DescriptionGetter() { @Override public CharSequence getDescription(JavadocContentAccess2 contentAccess) { return contentAccess.getExceptionDescription(simpleName); } }); }
/** * For the given method, returns the @throws/@exception tag description for the given * exception from an overridden method. * * @param method a method * @param simpleName the simple name of an exception * @return the description that replaces the <code>{@inheritDoc}</code> tag, * or <code>null</code> if none could be found */ public CharSequence getInheritedExceptionDescription(IMethod method, final String simpleName) { return getInheritedDescription(method, new DescriptionGetter() { @Override public CharSequence getDescription(JavadocContentAccess2 contentAccess) { return contentAccess.getExceptionDescription(simpleName); } }); }
/** * For the given method, returns the @param tag description for the given parameter from an * overridden method. * * @param method a method * @param paramIndex the index of the parameter * @return the description that replaces the <code>{@inheritDoc}</code> tag, * or <code>null</code> if none could be found */ public CharSequence getInheritedParamDescription(IMethod method, final int paramIndex) { return getInheritedDescription(method, new DescriptionGetter() { @Override public CharSequence getDescription(JavadocContentAccess2 contentAccess) throws JavaModelException { return contentAccess.getInheritedParamDescription(paramIndex); } }); }
/** * For the given method, returns the main description from an overridden method. * * @param method a method * @return the description that replaces the <code>{@inheritDoc}</code> tag, * or <code>null</code> if none could be found */ public CharSequence getInheritedMainDescription(IMethod method) { return getInheritedDescription(method, new DescriptionGetter() { @Override public CharSequence getDescription(JavadocContentAccess2 contentAccess) { return contentAccess.getMainDescription(); } }); }
/** * For the given method, returns the main description from an overridden method. * * @param method a method * @return the description that replaces the <code>{@inheritDoc}</code> tag, * or <code>null</code> if none could be found */ public CharSequence getInheritedMainDescription(IMethod method) { return getInheritedDescription(method, new DescriptionGetter() { @Override public CharSequence getDescription(JavadocContentAccess2 contentAccess) { return contentAccess.getMainDescription(); } }); }
/** * For the given method, returns the @return tag description from an overridden method. * * @param method a method * @return the description that replaces the <code>{@inheritDoc}</code> tag, * or <code>null</code> if none could be found */ public CharSequence getInheritedReturnDescription(IMethod method) { return getInheritedDescription(method, new DescriptionGetter() { @Override public CharSequence getDescription(JavadocContentAccess2 contentAccess) { return contentAccess.getReturnDescription(); } }); }
/** * For the given method, returns the @return tag description from an overridden method. * * @param method a method * @return the description that replaces the <code>{@inheritDoc}</code> tag, * or <code>null</code> if none could be found */ public CharSequence getInheritedReturnDescription(IMethod method) { return getInheritedDescription(method, new DescriptionGetter() { @Override public CharSequence getDescription(JavadocContentAccess2 contentAccess) { return contentAccess.getReturnDescription(); } }); }