Comments (4)
That is by design and is how Microsoft originally wrote the transformations way back when they were still done with XSL. If you check any existing API topic in the MS Help Viewer, you'll see it follows the same convention. It doesn't appear to be causing any issues even in the older Help 1 (CHM) viewer so I'm not sure there's anything that needs fixing.
from shfb.
Thanks for the explanation.
Searched Microsoft Help Viewer SDK (https://learn.microsoft.com/en-us/visualstudio/extensibility/internals/microsoft-help-viewer-sdk?view=vs-2022), it downs't say this convention. I am not familiar with this, so it looks like a convention from practice.
Just a note, for below code:
namespace NameSppace_A
{
ref class ClassA sealed
{
public:
property bool PropertyA
{
bool get();
void set(bool newValue);
}
};
}
Currently, content Microsoft.Help.F1 in html file of VS2013 presentation style is this:
<meta name="Microsoft.Help.F1" content="NameSppace_A.ClassA.PropertyA" />
<meta name="Microsoft.Help.F1" content="ClassA.PropertyA" />
<meta name="Microsoft.Help.F1" content="PropertyA" />
A very old Sandcastle generates this (also generate Microsoft.Help.F1 for property's get/set function).
<meta name="Microsoft.Help.F1" content="NameSppace_A.ClassA.PropertyA" />
<meta name="Microsoft.Help.F1" content="NameSppace_A.ClassA.get_PropertyA" />
<meta name="Microsoft.Help.F1" content="NameSppace_A.ClassA.set_PropertyA" />
Is there a way to also generate "Microsoft.Help.F1" for property get/set function or it is obsolete?
from shfb.
How old is very old? I don't recall it ever doing that and it may have been a bug since getters and setters aren't typically treated separately. I'm not sure there's any good reason too since they'd end up on the same topic anyway and you're not likely to search specifically for a getter or setter but the property itself.
from shfb.
Still thinks for the explanation.
BTW, the old sandcastle is very old.
That old Sandcastle had two separate parts: sandcastle document compiler tools and sandcastle help file builder. Old enough, ha (latest Sandcastle is a whole, doesn't have these separate parts).
from shfb.
Related Issues (20)
- 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
- HowTo - Install current HTML Help 1 Compiler for Client, Server or Docker image HOT 1
- Add Project Error in VS2022 Community HOT 2
- Build fails with "System.Drawing.Common is not supported on this platform" error when using '<alert>' element in '.aml' conceptual doc and 'Open XML Document' output style HOT 3
- Add some text in HTML documentation HOT 3
- Comment XML not recognized HOT 4
- Linked content files in SHFB project get not resolved HOT 4
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.