aboutsummaryrefslogtreecommitdiff
path: root/docs/refman
diff options
context:
space:
mode:
authorDaniel Mensinger <daniel@mensinger-ka.de>2022-01-23 16:03:41 +0100
committerEli Schwartz <eschwartz93@gmail.com>2022-04-07 17:16:26 -0400
commitf192ecd1effbed2dcc507707a780ecc8e95a537e (patch)
tree0bd70bccf31ce700856f542e1b4b75d0be0107ae /docs/refman
parent0808ae1b3d32eebd68342329428631e6a9be4248 (diff)
downloadmeson-f192ecd1effbed2dcc507707a780ecc8e95a537e.zip
meson-f192ecd1effbed2dcc507707a780ecc8e95a537e.tar.gz
meson-f192ecd1effbed2dcc507707a780ecc8e95a537e.tar.bz2
docs: refman: Add `arg_flattening` support
Diffstat (limited to 'docs/refman')
-rw-r--r--docs/refman/generatorjson.py1
-rw-r--r--docs/refman/generatormd.py1
-rw-r--r--docs/refman/jsonschema.py17
-rw-r--r--docs/refman/loaderyaml.py2
-rw-r--r--docs/refman/model.py1
-rw-r--r--docs/refman/templates/func.mustache4
6 files changed, 18 insertions, 8 deletions
diff --git a/docs/refman/generatorjson.py b/docs/refman/generatorjson.py
index 9f92342..d41cb71 100644
--- a/docs/refman/generatorjson.py
+++ b/docs/refman/generatorjson.py
@@ -72,6 +72,7 @@ class GeneratorJSON(GeneratorBase):
'optargs': {x.name: self._generate_arg(x, True) for x in func.optargs},
'kwargs': {x.name: self._generate_arg(x) for x in self.sorted_and_filtered(list(func.kwargs.values()))},
'varargs': self._generate_arg(func.varargs) if func.varargs else None,
+ 'arg_flattening': func.arg_flattening,
}
def _generate_objects(self, obj: Object) -> J.Object:
diff --git a/docs/refman/generatormd.py b/docs/refman/generatormd.py
index 42a0ee0..8fd0ef9 100644
--- a/docs/refman/generatormd.py
+++ b/docs/refman/generatormd.py
@@ -267,6 +267,7 @@ class GeneratorMD(GeneratorBase):
} if func.posargs or func.optargs else None,
'kwargs': {'args': [gen_arg_data(x) for x in self.sorted_and_filtered(list(func.kwargs.values()))]} if func.kwargs else None,
'varargs': gen_arg_data(func.varargs) if func.varargs else None,
+ 'arg_flattening': func.arg_flattening,
# For the feature taggs template
'since': func.since or None,
diff --git a/docs/refman/jsonschema.py b/docs/refman/jsonschema.py
index 6d6f98a..1b94856 100644
--- a/docs/refman/jsonschema.py
+++ b/docs/refman/jsonschema.py
@@ -8,7 +8,7 @@ import typing as T
# the Meson version
VERSION_MAJOR = 1 # Changes here indicate breaking format changes (changes to existing keys)
-VERSION_MINOR = 0 # Changes here indicate non-breaking changes (only new keys are added to the existing structure)
+VERSION_MINOR = 1 # Changes here indicate non-breaking changes (only new keys are added to the existing structure)
class BaseObject(T.TypedDict):
'''
@@ -43,13 +43,14 @@ class Function(BaseObject):
'''
Represents a function or method.
'''
- returns: T.List[Type] # A non-empty list of types that are supported.
- returns_str: str # Formated version of `returns`. Is guranteed to not contain any whitespaces.
- example: T.Optional[str]
- posargs: T.Dict[str, Argument]
- optargs: T.Dict[str, Argument]
- kwargs: T.Dict[str, Argument]
- varargs: T.Optional[Argument]
+ returns: T.List[Type] # A non-empty list of types that are supported.
+ returns_str: str # Formatted version of `returns`. Is guaranteed to not contain any whitespaces.
+ example: T.Optional[str]
+ posargs: T.Dict[str, Argument]
+ optargs: T.Dict[str, Argument]
+ kwargs: T.Dict[str, Argument]
+ varargs: T.Optional[Argument]
+ arg_flattening: bool
class Object(BaseObject):
'''
diff --git a/docs/refman/loaderyaml.py b/docs/refman/loaderyaml.py
index 8f56d79..fc06b0d 100644
--- a/docs/refman/loaderyaml.py
+++ b/docs/refman/loaderyaml.py
@@ -89,6 +89,7 @@ class StrictTemplate(Template):
Optional('varargs_inherit', default=''): Str(),
Optional('kwargs'): MapPattern(Str(), self.s_kwarg),
Optional('kwargs_inherit', default=[]): OrValidator(OrValidator(Seq(Str()), EmptyList()), Str()),
+ Optional('arg_flattening', default=True): Bool(),
})
self.s_object = Map({
@@ -138,6 +139,7 @@ class FastTemplate(Template):
'varargs_inherit': '',
'kwargs': {},
'kwargs_inherit': [],
+ 'arg_flattening': True,
}
s_object = {
diff --git a/docs/refman/model.py b/docs/refman/model.py
index 8a051c9..0c65c58 100644
--- a/docs/refman/model.py
+++ b/docs/refman/model.py
@@ -77,6 +77,7 @@ class Function(NamedObject, FetureCheck):
optargs_inherit: str
varargs_inherit: str
kwargs_inherit: T.List[str]
+ arg_flattening: bool
@dataclass
class Method(Function):
diff --git a/docs/refman/templates/func.mustache b/docs/refman/templates/func.mustache
index 3e6209f..c601f78 100644
--- a/docs/refman/templates/func.mustache
+++ b/docs/refman/templates/func.mustache
@@ -25,6 +25,10 @@
<p style="padding: 5px; margin: 0px;"></p> <!-- A bit more space -->
{{base_level}}## Arguments
+
+{{^arg_flattening}}
+ [Argument flattening](Syntax.md#argument-flattening) is **NOT SUPPORTED** by this function.
+{{/arg_flattening}}
{{/has_args}}
{{#posargs}}