Skip to content

[Feature Request] Include type on toc.yml #10089

@frarees

Description

@frarees

Use case

I want to filter out TOC entries based on their member type. For example, to list only namespaces and classes.

Current behavior

toc.yml doesn't contain type information.

Note

When using memberLayout: "separatePages", the additional TOC entries pushed to the model contain this information.

How to reproduce

For example, given this source:

namespace Lib
{
    public class Lib
    {
        public enum MyEnum
        {
            Value1,
            Value2,
        }

        public class SubLib
        {
            public float Foo { get; private set; }
        }

        public MyEnum MyEnumField;
        public float Foo { get; private set; }
        public float Bar { get; set; }
        public int Baz;

        public void MyMethod()
        {
            System.Console.WriteLine("Hello, World!");
        }
    }
}

The generated model looks like this (pre-transformations):

model

And the HTML TOC looks like this:

toc

Proposal

See #10090.

Note

This might require some attention to the templates, since there's assumptions based on entries having defined the type property - which makes the TOC render like this:

image

Metadata

Metadata

Assignees

No one assigned

    Labels

    tocNavigation components like menus, TOC and breadcrumbs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions