Determine why a symbol is extracted
Synopsis
Declared in <mrdocs/Metadata/ExtractionMode.hpp>
enum class ExtractionMode : int;
Members
| Name |
Description |
| Regular |
We're extracting the current symbol because it passes all filters. |
| SeeBelow |
We're extracting the current symbol because it passes all filters, but we should also tag it as see-below because it passes one of the see-below filters. This symbol has its own page but it has no details and no child members. |
| ImplementationDefined |
We're extracting the current symbol because it passes all filters, but we should also tag it as implementation-defined because one of its parents matches the implementation-defined filter. This symbol has no page and other symbols that depend on it will just render /implementation-defined/. |
| Dependency |
We're extracting the current symbol even though it doesn't pass all filters because it's a direct dependency of a symbol that does pass all filters and needs information about it (e.g.: base classes outside the filters). This symbol has no page and it might even deleted from the corpus if no other symbol depends on it after we extracted the information we wanted from it in post-processing steps. |
Non-Member Functions
| Name |
Description |
leastSpecific | Compare ExtractionModes and returns the least specific |
mostSpecific | Compare ExtractionModes and returns the most specific |
toString | Return the name of the InfoKind as a string. |
Description
The enum constants are ordered by specificity, with the least specific at the beginning and the most specific at the end.