Comments (2)
For the group pages such as properties, methods, etc., you need to fully qualify the name and use the proper group prefix. Typically, it will be the fully qualified name of the class prefixed with something like "Methods." or "Properties.". Generic classes will need the generic type parameter count included in their member ID as well. Method overloads, including those for constructors, are a little different as shown in the examples below:
Methods.T:XMLCommentsExamples.GenericClass`2
Properties.T:XMLCommentsExamples.GenericClass`2
Events.T:XMLCommentsExamples.SampleClass
Overload:SandcastleBuilder.Utils.FilePath.#ctor
If in doubt, the ID to use can be found by looking at the generated HTML for the page and looking for the ID element depending on which presentation style you're using. For example, in the VS2013 style, the ID is stored in the "Microsoft.Help.Id" meta element.
For overloads, you can use the cref
notation "O:SandcastleBuilder.Utils.FilePath.#ctor". The "O:" prefix will translate to the method overload page. For the others you'll have to use href
notation such as:
<see href="html/Events.T:XMLCommentsExamples.SampleClass.htm">Sample Class Events</see>
from shfb.
Perfect! Just what I was looking for. :)
Thanks for the help.
from shfb.
Related Issues (20)
- Please document methods parameters regardless syntax filters setup HOT 2
- BE0066: ResolveReferenceLinksComponent: [...] Member ID URL resolver service failed. HOT 5
- `See` element and override within sealed class HOT 2
- Easy to conflict with Microsoft.Help.F1 HOT 4
- autoOutline differences between Default2022 and VS2013 styles HOT 5
- [Question] My help file builds successfully but only has one namespace HOT 4
- Cannot install extension on arm64 HOT 1
- Enable TOC using current presentation style HOT 4
- TOC overlaying wide content HOT 4
- Building with NuGet tools with MsBuild is broken in Visual Studio HOT 4
- Numeric constant formatting for enumeration to allow searching for constant HOT 2
- Error BE0065: An error occurred while attempting to transform the reflection data to a topic. When Extensions Methods to Enum. HOT 3
- Some types excluded from documentation? HOT 3
- Documenting a `net8.0` project when using `msbuild.exe` HOT 3
- Linux/Docker builds HOT 5
- An error occurred while attempting to transform the reflection data to a topic. The error message was: System.NullReferenceException HOT 3
- Problem with installer when only VS 2022 is installed. HOT 4
- Support for Nuget Central Package Management
- CodeBlockComponent: F# closing endregion comment tag included in rendered text.
- Sandcastle is running out of memory HOT 7
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from shfb.