Skip to content

Commit

Permalink
SFINAE extraction documentation
Browse files Browse the repository at this point in the history
#docs
  • Loading branch information
alandefreitas committed Jan 15, 2025
1 parent ba81607 commit e66e662
Show file tree
Hide file tree
Showing 6 changed files with 589 additions and 168 deletions.
2 changes: 1 addition & 1 deletion docs/mrdocs.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@
},
"sfinae": {
"default": true,
"description": "When set to true, MrDocs detects SFINAE expressions in the source code and extracts them as part of the documentation. Expressions such as `std::enable_if<...>` are detected, removed, and documented as a requirement.",
"description": "When set to true, MrDocs detects SFINAE expressions in the source code and extracts them as part of the documentation. Expressions such as `std::enable_if<...>` are detected, removed, and documented as a requirement. MrDocs uses an algorithm that extracts SFINAE infomation from types by identifying inspecting the primary template and specializations to detect the result type and the controlling expressions in a specialization.",
"title": "Detect and reduce SFINAE expressions",
"type": "boolean"
},
Expand Down
Loading

0 comments on commit e66e662

Please sign in to comment.