question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Inheritdoc behaviour

See original GitHub issue

First, thanks for this great tool!

I wanted to inherit text from another member, and then add it to. I tried:

I tried it as a top level XML:

 /// <inheritdoc cref="Member.ref"/>
  /// <summary>
  /// Blah Blah
  /// 
  /// </summary>

XML:
     <member name="..">
            <inheritdoc cref=".."/>
            <summary>
            Blah Blah
            </summary>

But the output from the tool removes the Blah Blah and you just get the inherited text.

Tried for fun:

  /// <summary>
  /// Blah Blah
  /// <inheritdoc cref="Member.ref"/>
  /// </summary>

and got in the XML:

    </member>
        <member name="M:..">
            <summary>
            Blah Blah
            <inheritdoc cref="Member.ref"/>
            </summary>

Same result.

Is this intentional behaviour?

Many Thanks

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:8 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
robbyxp1commented, Jan 14, 2022

Hi, that sorted it, thanks.

I’ve ended up using

    <DefaultDocumentationGeneratedPages>Classes,Delegates,Interfaces</DefaultDocumentationGeneratedPages>
    <DefaultDocumentationFileNameMode>FullName</DefaultDocumentationFileNameMode>
    <DefaultDocumentationRemoveFileExtensionFromLinks>True</DefaultDocumentationRemoveFileExtensionFromLinks>
    <DefaultDocumentationExternLinksFiles>docexternlinks.txt</DefaultDocumentationExternLinksFiles>
    <DefaultDocumentationGeneratedAccessModifiers>Public,Protected</DefaultDocumentationGeneratedAccessModifiers>
    <DefaultDocumentationNestedTypeVisibilities>DeclaringType</DefaultDocumentationNestedTypeVisibilities>

And with a little moving around of the structures into classes (I had some just in the namespace, and they appeared in index.md) there was only a few) both the structures and enums now appear in the class .md file, which is what i wanted.

Thanks you for your help. This is a great tool.

I’ll close it now.

0reactions
Dorakucommented, Jan 14, 2022

hum I didn’t plan on having that level of customization for which item has its own page or not but maybe it is possible to add it in the new json configuration format that is coming, I will check how it would work.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Any benefit to using <inheritdoc/>?
The <inheritdoc> tag is still very needed. I use it often. It allows you to inherit comments or comment parts also from not...
Read more >
Add a way to inherit documentation <inheritdoc /> #313
The inheritance rules determine the element(s) from which documentation is inherited. The behavior is unspecified if a cycle exists in these ...
Read more >
Option to use {@inheritdoc} in Javadoc instead of copying ...
Such a comment is completely superfluous as the standard behaviour of javadoc is to copy the parent's javadoc anyway. I have a large...
Read more >
Inherit behaviour from Map to implement Access - Elixir Forum
I'm trying to use my own struct (as a extension of map) in my code but I would really love to use the...
Read more >
inherit - CSS: Cascading Style Sheets - MDN Web Docs
The inherit CSS keyword causes the element to take the computed value of the property from its parent element. It can be applied...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found