Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Support for <seealso /> links #23

Merged
merged 2 commits into from
Nov 19, 2024

Conversation

jperson2000
Copy link
Contributor

@jperson2000 jperson2000 commented Nov 18, 2024

Description

This update adds support for <seealso cref=""/> and <seealso href=""/> links for types and members. A new SeeAlsoTag type contains the Cref, Href, and Text for any seealso link encountered.

How Has This Been Tested?

This was tested by adding <seealso /> links to the XML docs for the MyClass test class, and adding a unit test which ensures the links are parsed properly.

Type of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation (fix or improvement to the website or code docs)

Checklist

  • The PR is submitted to the correct branch (dev).
  • My code follows the code style of this project.
  • I've added relevant tests.

@jperson2000
Copy link
Contributor Author

Thanks for the wonderful library, @loxsmoke ! Let me know if you want me to roll back the other whitespace changes; I habitually do a Format Document before saving lol.

@@ -1,5 +1,6 @@
using System;
using System.Collections.Generic;
using System.ComponentModel.Design;
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this using necessary?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! That was taken back out.

@loxsmoke
Copy link
Owner

Great pull request!
Whitespace changes are OK. Let's keep them.

@jperson2000 jperson2000 requested a review from loxsmoke November 18, 2024 16:56
@loxsmoke loxsmoke merged commit 64b289b into loxsmoke:master Nov 19, 2024
1 check passed
@jperson2000 jperson2000 deleted the feature/seealso-support branch November 19, 2024 15:28
@mikes-gh
Copy link

Be good to add this to the repo README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants