Coder Social home page Coder Social logo

Comments (4)

EWSoftware avatar EWSoftware commented on July 29, 2024 1

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.

livisen avatar livisen commented on July 29, 2024

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.

EWSoftware avatar EWSoftware commented on July 29, 2024

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.

livisen avatar livisen commented on July 29, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.