From ad7b600345778d0f4c699c439c23f12b26169e9e Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Tue, 17 Nov 2026 11:14:55 -0500 Subject: [PATCH 1/7] Try Fix Doc Bugs --- .../api_wiki/ManagedReference.extension.js | 52 ++++++++++++------- .../ManagedReference.html.primary.tmpl | 26 ++++++++++ .../partials/class.header.tmpl.partial | 24 ++++++--- 3 files changed, 77 insertions(+), 25 deletions(-) create mode 100644 docs/template/api_wiki/ManagedReference.html.primary.tmpl diff --git a/docs/template/api_wiki/ManagedReference.extension.js b/docs/template/api_wiki/ManagedReference.extension.js index a59b870c..9ccebc40 100644 --- a/docs/template/api_wiki/ManagedReference.extension.js +++ b/docs/template/api_wiki/ManagedReference.extension.js @@ -1,23 +1,16 @@ - exports.postTransform = function (model) { - console.log("ManagedReference.extension.js EXECUTED"); - console.log("Root model: " + JSON.stringify(model)); - setMemberFlags(model); - return model; }; function setMemberFlags(item, inheritedType) { if (!item || typeof item !== 'object') return; - // Determine the current item's declaration type. var t = item.type ? String(item.type).toLowerCase() : inheritedType; - // DocFX member-group containers identify their children - // through properties such as inMethod, inProperty, etc. + // Member-group containers carry their kind in typePropertyName (inMethod, ...) if (item.typePropertyName) { var groupType = String(item.typePropertyName) .replace(/^in/, '') @@ -28,15 +21,25 @@ function setMemberFlags(item, inheritedType) { } } - // Container / Type declarations + // ---- Declaration kinds ------------------------------------------------- + // postTransform runs AFTER ManagedReference.common.js's transform, which + // already set isClass = true for class/struct/interface/delegate because + // ManagedReference.html.primary.tmpl dispatches on isClass. Setting + // isClass = (t === 'class') here would clobber that and blank every + // interface, struct and delegate page. Mirror common.js instead. item.isNamespace = (t === 'namespace'); - item.isClass = (t === 'class'); + item.isClass = ( + t === 'class' || + t === 'struct' || + t === 'interface' || + t === 'delegate' + ); item.isStruct = (t === 'struct'); item.isInterface = (t === 'interface'); item.isEnum = (t === 'enum'); item.isDelegate = (t === 'delegate'); - // Member declarations + // ---- Member kinds ------------------------------------------------------ item.isConstructor = (t === 'constructor'); item.isMethod = (t === 'method'); item.isProperty = (t === 'property'); @@ -44,13 +47,28 @@ function setMemberFlags(item, inheritedType) { item.isEvent = (t === 'event'); item.isOperator = (t === 'operator'); - // Useful grouped helpers + // ---- in* flags, as consumed by the partials ({{#inClass}}, {{#inEnum}}) -- + // common.js sets these only on the root and on group containers. Emit them + // here too so the partials never depend on transform order. + item.inNamespace = (t === 'namespace'); + item.inClass = (t === 'class'); + item.inStruct = (t === 'struct'); + item.inInterface = (t === 'interface'); + item.inEnum = (t === 'enum'); + item.inDelegate = (t === 'delegate'); + + item.inConstructor = (t === 'constructor'); + item.inMethod = (t === 'method'); + item.inProperty = (t === 'property'); + item.inField = (t === 'field'); + item.inEvent = (t === 'event'); + item.inOperator = (t === 'operator'); + + // ---- Aggregates -------------------------------------------------------- item.isType = ( item.isClass || - item.isStruct || - item.isInterface || item.isEnum || - item.isDelegate + item.isNamespace ); item.isMember = ( @@ -62,8 +80,6 @@ function setMemberFlags(item, inheritedType) { item.isOperator ); - // Recursively process nested models. - // Pass the current group type down to its children. if (Array.isArray(item.children)) { item.children.forEach(function (child) { setMemberFlags(child, t); @@ -75,4 +91,4 @@ function setMemberFlags(item, inheritedType) { setMemberFlags(child, t); }); } -} +} \ No newline at end of file diff --git a/docs/template/api_wiki/ManagedReference.html.primary.tmpl b/docs/template/api_wiki/ManagedReference.html.primary.tmpl new file mode 100644 index 00000000..56288236 --- /dev/null +++ b/docs/template/api_wiki/ManagedReference.html.primary.tmpl @@ -0,0 +1,26 @@ +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} +{{!master(layout/_master.tmpl)}} + +{{#isNamespace}} + {{>partials/namespace}} +{{/isNamespace}} + +{{#_splitReference}} +{{#isClass}} + {{>partials/class.memberpage}} +{{/isClass}} +{{/_splitReference}} + +{{^_splitReference}} +{{^isEnum}} +{{#isType}} + {{>partials/class}} +{{/isType}} +{{/isEnum}} +{{/_splitReference}} + +{{#isEnum}} + {{>partials/enum}} +{{/isEnum}} + +{{>partials/customMREFContent}} \ No newline at end of file diff --git a/docs/template/api_wiki/partials/class.header.tmpl.partial b/docs/template/api_wiki/partials/class.header.tmpl.partial index 1405c1ff..a413dd75 100644 --- a/docs/template/api_wiki/partials/class.header.tmpl.partial +++ b/docs/template/api_wiki/partials/class.header.tmpl.partial @@ -212,13 +212,23 @@ {{/extensionMethods.0}} {{#extensionMethods}} -
- {{#definition}} - - {{/definition}} - {{^definition}} - - {{/definition}} +
+
+ {{#definition}} + + {{/definition}} + {{^definition}} + + {{/definition}} +
+ {{#specName.0.value}} +
+
{{{specName.0.value}}}
+
+ {{/specName.0.value}} + {{#summary}} +
{{{summary}}}
+ {{/summary}}
{{/extensionMethods}} From 48b313e4cd3665ca3610f8ccfc75bd4f5d4c69b8 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Tue, 17 Nov 2026 11:20:27 -0500 Subject: [PATCH 2/7] Remove Namespace from Aggregate --- docs/template/api_wiki/ManagedReference.extension.js | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/template/api_wiki/ManagedReference.extension.js b/docs/template/api_wiki/ManagedReference.extension.js index 9ccebc40..2206836f 100644 --- a/docs/template/api_wiki/ManagedReference.extension.js +++ b/docs/template/api_wiki/ManagedReference.extension.js @@ -67,8 +67,7 @@ function setMemberFlags(item, inheritedType) { // ---- Aggregates -------------------------------------------------------- item.isType = ( item.isClass || - item.isEnum || - item.isNamespace + item.isEnum ); item.isMember = ( From b677e4c5091541a19893c460ae9138ab2612a6c5 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Tue, 17 Nov 2026 11:33:46 -0500 Subject: [PATCH 3/7] Make summary match the correct extension --- .../api_wiki/ManagedReference.extension.js | 59 +++++++++++++++++++ .../partials/class.header.tmpl.partial | 22 +++---- 2 files changed, 71 insertions(+), 10 deletions(-) diff --git a/docs/template/api_wiki/ManagedReference.extension.js b/docs/template/api_wiki/ManagedReference.extension.js index 2206836f..f59bb320 100644 --- a/docs/template/api_wiki/ManagedReference.extension.js +++ b/docs/template/api_wiki/ManagedReference.extension.js @@ -1,8 +1,67 @@ exports.postTransform = function (model) { + var uidLookup = {}; + buildUidLookup(model, uidLookup); + setMemberFlags(model); + setExtensionMethodSummaries(model, uidLookup); + return model; }; +function buildUidLookup(item, lookup) { + if (!item || typeof item !== 'object') return; + + if (item.uid) { + lookup[String(item.uid)] = item; + } + + if (Array.isArray(item.children)) { + item.children.forEach(function (child) { + buildUidLookup(child, lookup); + }); + } + + if (Array.isArray(item.items)) { + item.items.forEach(function (child) { + buildUidLookup(child, lookup); + }); + } +} + +function setExtensionMethodSummaries(item, uidLookup) { + if (!item || typeof item !== 'object') return; + + if (Array.isArray(item.extensionMethods)) { + item.extensionMethods.forEach(function (extensionMethod) { + if (!extensionMethod || typeof extensionMethod !== 'object') return; + + var definitionUid = extensionMethod.definition || extensionMethod.uid; + + if (!definitionUid) return; + + var definition = uidLookup[String(definitionUid)]; + + if (!definition) return; + + if (definition.summary) { + extensionMethod.summary = definition.summary; + } + }); + } + + if (Array.isArray(item.children)) { + item.children.forEach(function (child) { + setExtensionMethodSummaries(child, uidLookup); + }); + } + + if (Array.isArray(item.items)) { + item.items.forEach(function (child) { + setExtensionMethodSummaries(child, uidLookup); + }); + } +} + function setMemberFlags(item, inheritedType) { if (!item || typeof item !== 'object') return; diff --git a/docs/template/api_wiki/partials/class.header.tmpl.partial b/docs/template/api_wiki/partials/class.header.tmpl.partial index a413dd75..c92d1701 100644 --- a/docs/template/api_wiki/partials/class.header.tmpl.partial +++ b/docs/template/api_wiki/partials/class.header.tmpl.partial @@ -207,28 +207,30 @@

Extension Methods (Click me to Expand)

-

The following are methods in which you can use that act as extensions to this type:

+

The following are methods which can be used as extensions to this type:

{{/extensionMethods.0}} {{#extensionMethods}}
- {{#definition}} - - {{/definition}} - {{^definition}} - - {{/definition}} + {{#definition}} + + {{/definition}} + {{^definition}} + + {{/definition}}
+ + {{#summary}} +
{{{summary}}}
+ {{/summary}} + {{#specName.0.value}}
{{{specName.0.value}}}
{{/specName.0.value}} - {{#summary}} -
{{{summary}}}
- {{/summary}}
{{/extensionMethods}} From 9ee39a62f4ad5506213ada4e62271001dc18d176 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Tue, 17 Nov 2026 11:46:40 -0500 Subject: [PATCH 4/7] Fix Extension Summaries --- .../api_wiki/ManagedReference.extension.js | 59 ------------------- .../partials/class.header.tmpl.partial | 13 +--- .../partials/extensionMethod.summary.tmpl | 3 + 3 files changed, 6 insertions(+), 69 deletions(-) create mode 100644 docs/template/api_wiki/partials/extensionMethod.summary.tmpl diff --git a/docs/template/api_wiki/ManagedReference.extension.js b/docs/template/api_wiki/ManagedReference.extension.js index f59bb320..2206836f 100644 --- a/docs/template/api_wiki/ManagedReference.extension.js +++ b/docs/template/api_wiki/ManagedReference.extension.js @@ -1,67 +1,8 @@ exports.postTransform = function (model) { - var uidLookup = {}; - buildUidLookup(model, uidLookup); - setMemberFlags(model); - setExtensionMethodSummaries(model, uidLookup); - return model; }; -function buildUidLookup(item, lookup) { - if (!item || typeof item !== 'object') return; - - if (item.uid) { - lookup[String(item.uid)] = item; - } - - if (Array.isArray(item.children)) { - item.children.forEach(function (child) { - buildUidLookup(child, lookup); - }); - } - - if (Array.isArray(item.items)) { - item.items.forEach(function (child) { - buildUidLookup(child, lookup); - }); - } -} - -function setExtensionMethodSummaries(item, uidLookup) { - if (!item || typeof item !== 'object') return; - - if (Array.isArray(item.extensionMethods)) { - item.extensionMethods.forEach(function (extensionMethod) { - if (!extensionMethod || typeof extensionMethod !== 'object') return; - - var definitionUid = extensionMethod.definition || extensionMethod.uid; - - if (!definitionUid) return; - - var definition = uidLookup[String(definitionUid)]; - - if (!definition) return; - - if (definition.summary) { - extensionMethod.summary = definition.summary; - } - }); - } - - if (Array.isArray(item.children)) { - item.children.forEach(function (child) { - setExtensionMethodSummaries(child, uidLookup); - }); - } - - if (Array.isArray(item.items)) { - item.items.forEach(function (child) { - setExtensionMethodSummaries(child, uidLookup); - }); - } -} - function setMemberFlags(item, inheritedType) { if (!item || typeof item !== 'object') return; diff --git a/docs/template/api_wiki/partials/class.header.tmpl.partial b/docs/template/api_wiki/partials/class.header.tmpl.partial index c92d1701..e58070d5 100644 --- a/docs/template/api_wiki/partials/class.header.tmpl.partial +++ b/docs/template/api_wiki/partials/class.header.tmpl.partial @@ -207,24 +207,17 @@

Extension Methods (Click me to Expand)

-

The following are methods which can be used as extensions to this type:

+

The following are methods which can be used as extensions to this type:

{{/extensionMethods.0}} {{#extensionMethods}}
- {{#definition}} - - {{/definition}} - {{^definition}} - - {{/definition}} +
- {{#summary}} -
{{{summary}}}
- {{/summary}} + {{#specName.0.value}}
diff --git a/docs/template/api_wiki/partials/extensionMethod.summary.tmpl b/docs/template/api_wiki/partials/extensionMethod.summary.tmpl new file mode 100644 index 00000000..064f6a87 --- /dev/null +++ b/docs/template/api_wiki/partials/extensionMethod.summary.tmpl @@ -0,0 +1,3 @@ +{{#summary}} +
{{{summary}}}
+{{/summary}} \ No newline at end of file From 66b72cc18fc44e1a645490748afbeee760afb69e Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Tue, 17 Nov 2026 11:50:59 -0500 Subject: [PATCH 5/7] Extension stuff --- docs/template/api_wiki/ManagedReference.extension.js | 7 +++++++ docs/template/api_wiki/partials/class.header.tmpl.partial | 7 ++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/template/api_wiki/ManagedReference.extension.js b/docs/template/api_wiki/ManagedReference.extension.js index 2206836f..1feda089 100644 --- a/docs/template/api_wiki/ManagedReference.extension.js +++ b/docs/template/api_wiki/ManagedReference.extension.js @@ -1,4 +1,11 @@ exports.postTransform = function (model) { + if (model.extensionMethods && model.extensionMethods.length > 0) { + console.log( + "EXTENSION METHOD MODEL:", + JSON.stringify(model.extensionMethods[0], null, 2) + ); + } + setMemberFlags(model); return model; }; diff --git a/docs/template/api_wiki/partials/class.header.tmpl.partial b/docs/template/api_wiki/partials/class.header.tmpl.partial index e58070d5..1459f509 100644 --- a/docs/template/api_wiki/partials/class.header.tmpl.partial +++ b/docs/template/api_wiki/partials/class.header.tmpl.partial @@ -214,7 +214,12 @@ {{#extensionMethods}}
- + {{#definition}} + + {{/definition}} + {{^definition}} + + {{/definition}}
From 37826e1b2b165b3160b9e946bcc37bd671b60d6f Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Tue, 17 Nov 2026 11:54:47 -0500 Subject: [PATCH 6/7] More Extension Stuff --- docs/template/api_wiki/ManagedReference.extension.js | 2 +- docs/template/api_wiki/partials/class.header.tmpl.partial | 7 ++++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/template/api_wiki/ManagedReference.extension.js b/docs/template/api_wiki/ManagedReference.extension.js index 1feda089..3c2a969a 100644 --- a/docs/template/api_wiki/ManagedReference.extension.js +++ b/docs/template/api_wiki/ManagedReference.extension.js @@ -1,7 +1,7 @@ exports.postTransform = function (model) { if (model.extensionMethods && model.extensionMethods.length > 0) { console.log( - "EXTENSION METHOD MODEL:", + "EXTENSION METHOD MODEL: " + JSON.stringify(model.extensionMethods[0], null, 2) ); } diff --git a/docs/template/api_wiki/partials/class.header.tmpl.partial b/docs/template/api_wiki/partials/class.header.tmpl.partial index 1459f509..f5e62d06 100644 --- a/docs/template/api_wiki/partials/class.header.tmpl.partial +++ b/docs/template/api_wiki/partials/class.header.tmpl.partial @@ -222,7 +222,12 @@ {{/definition}}
- + {{#definition}} + + {{/definition}} + {{^definition}} + + {{/definition}} {{#specName.0.value}}
From ae1164db82a4d4e422463d58fa6f4de72d923be2 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Tue, 17 Nov 2026 12:05:47 -0500 Subject: [PATCH 7/7] remove debug logging in wiki builds --- docs/template/api_wiki/ManagedReference.extension.js | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/template/api_wiki/ManagedReference.extension.js b/docs/template/api_wiki/ManagedReference.extension.js index 3c2a969a..2206836f 100644 --- a/docs/template/api_wiki/ManagedReference.extension.js +++ b/docs/template/api_wiki/ManagedReference.extension.js @@ -1,11 +1,4 @@ exports.postTransform = function (model) { - if (model.extensionMethods && model.extensionMethods.length > 0) { - console.log( - "EXTENSION METHOD MODEL: " + - JSON.stringify(model.extensionMethods[0], null, 2) - ); - } - setMemberFlags(model); return model; };