Stack Overflow
Stack Overflow

Questions tagged [inheritdoc]

16 questions
43
votes
2 answers

Correct syntax for inheritDoc in phpDocumentor

What is the correct syntax for @inheritDoc in phpDocumentor if I just want to inherit all of the documentation from parent? Maybe more than one syntax is correct? @inheritDoc {@inheritDoc} @inheritdoc {@inheritdoc} The documentation is pretty…
Borek Bernard
  • 50,745
  • 59
  • 165
  • 240
43
votes
3 answers

Javadoc {@inheritDoc} tag class

I would like to use the {@inheritDoc} class to inherit methods from my abstract class. In the documentation for the abstract class, I refer to the abstract class by name. How can I tag this so when the subclass inherits the documentation from the…
LandonSchropp
  • 10,084
  • 22
  • 86
  • 149
23
votes
2 answers

Is it possible to inherit documentation from specific parameters?

Visual Studio 2017, ReSharper 2017, C# project I am trying to inherit the documentation of a method's parameter by using the select attribute, but it doesn't seem to work as expected. According to this article (…
IneedHelp
  • 1,630
  • 1
  • 27
  • 58
17
votes
3 answers

Java Documentation Override Method does not InheritDoc

A method that overrides another method does not inherit documentation of the method it is overriding. Is there any way to explicitly tell it to inherit the documentation? /** * {@inheritDoc} * * This implementation uses a dynamic programming…
Verhogen
  • 27,221
  • 34
  • 90
  • 109
11
votes
1 answer

Can I use to reference the XML summary of another variable?

When I'm writing functions for my project, and more specifically, their XML documentation comments, I find myself repeating the comments for a specific parameter often. This leads to misleading documentation sometimes (as copy pasting usually…
Eldemarkki
  • 143
  • 1
  • 8
9
votes
2 answers

Why won't Javadoc make my subclasses inherit documentation from Java's classes?

I've been searching for an answer for several months and I have tried multiple things, including unzipping the Compressed folder src.zip and using it as a parameter for Javadoc (for example: javadoc -sourcepath src com.example.test) This is the…
user766413
  • 121
  • 1
  • 6
8
votes
1 answer

{@inheritDoc} not inheriting superclass javadoc in Eclipse

When I use {@inheritDoc} in Eclipse, the superclass' javadoc comments are not appearing in my class' javadoc. I have the following piece of code: import javax.swing.table.AbstractTableModel; public class TestTableModel extends AbstractTableModel…
tekumara
  • 8,357
  • 10
  • 57
  • 69
3
votes
0 answers

How to use `` when one of the parameters have the `in` keyword?

I have the following function: public int Get(ref X a, ref Y b, int c, in Z d = default) { ... } and an overload which I'm trying to use from: /// /// ... /// ///…
Bilal Akil
  • 4,716
  • 5
  • 32
  • 52
3
votes
1 answer

Auto add /// when implementing methods from interface

Does it exist on Visual Studio 2019 or ReSharper a way to automatically add /// when implementing missing members from an interface/base class? I checked quite a bit on Google but couldn't find anything.
Alvin Sartor
  • 2,249
  • 4
  • 20
  • 36
2
votes
0 answers

Is there an implicit < inheritdoc />?

In Visual Studio I noticed that when i hover a method, it acts like there is an < inheritdoc />, when there isn't. Visual example here Why and from where is that? Because of Visual Studio? Also, should I still add the < inheritdoc /> or leave it…
Remo
  • 65
  • 5
2
votes
1 answer

Stylecop doesn't understand

I'm trying to use Stylecop 4.7.31 I have a project, where an interface is declared: public interface IRmlManager { /// /// Adds the notification. /// /// The notification…
Alek86
  • 1,489
  • 3
  • 17
  • 26
1
vote
1 answer

{@inheritdoc} replaced by @ERROR

I have recently installed Eclipse for PHP on a new laptop and checked out packages from TYPO3.Flow, but whenever I use the "format this file" option in Eclipse, it will replace every instance of {@inheritdoc} in the comment annotations above…
Erik
  • 3,598
  • 14
  • 29
1
vote
1 answer

Javadoc through Ant task with {@inheritDoc} from J2SE classes

I generate documentation for a project using an Ant task. In several places, I wanted to inherit documentation from the standard classes, so I used {@inheritDoc} which allowed me to see the Javadoc in Eclipse, but it wouldn't show up in the HTML…
miorel
  • 1,863
  • 2
  • 14
  • 18
1
vote
1 answer

How to accomplish inheriting Javadoc comments from JDK with Gradle Javadoc task?

I want my Javadoc to inherit comments from standard JDK classes. For this, I need to add JDK sources to -sourcepath javadoc option. Not to generate documentation for JDK classes themselves, I would specify packages via -packagenames or -subpackages…
leventov
  • 14,760
  • 11
  • 69
  • 98
0
votes
1 answer

Filter content of inherited param comments

I have comments like this: /// some summary /// /// Comment 0 /// Comment 1 /// Comment 2 /// /// ///
tm1
  • 1,180
  • 12
  • 28
1
2