Open cjsha opened 1 month ago
Hi, I'm wondering if I can provide additional information or be of help for this issue. I think it's similar or a duplicate of #9234. Thanks
[Category(ConfigurationCategory)] & [Description(
)] are not pulled into syntax.content
These attributes are defined as System.ComponentModel
namespace.
So is seems these attributes are excluded by defaultfilterconfig.yml
's setting.
https://github.com/dotnet/docfx/blob/5683814d296562ef782f703061d01f69bd7899df/src/Docfx.Dotnet/Resources/defaultfilterconfig.yml#L41-L43
How would it work if explicitly including these attributes at custom filter config file settings (filter.yml
)
Yes! This helped. For anyone who runs into a similar problem, I added these lines to filter.yml
attributeRules:
- include: # this is necessary to pull our custom attributes into .yml metadata without disabling the docfx default filter
uidRegex: ^System\.ComponentModel\.(CategoryAttribute|DescriptionAttribute)$
type: Type
Thanks so much.
Describe the bug For example:
[Range(0, 1000000)]
is pulled into syntax.content forBeatsPerSecond
[Category(ConfigurationCategory)]
&[Description(<whatever>)]
are not pulled into syntax.content for eitherBeatsPerSecond
orEnable
The relevant files for this example are: OpenEphys.Onix1.ConfigureHeartbeart.yml (generated locally by
docfx metadata
command) and ConfigureHeartbeart.csTo Reproduce Steps to reproduce the behavior:
Expected behavior All attributes are pullled into the .yml file after running the
metadata
commandContext (please complete the following information):
docfx.json
configAdditional context I'm not sure if we're doing something wrong or if this is a docfx bug. Please let me know if I can help. or provide anymore information