Mirrors/servo
1
0
Fork 0
mirror of https://github.com/servo/servo.git synced 2025-08-05 05:30:08 +01:00
Code Issues Projects Releases Packages Wiki Activity

Auto merge of #7903 - Ms2ger:codegen-docs, r=Manishearth

Browse source 
Add support for documenting CGAbstractMethods.



<!-- Reviewable:start -->
[<img src="https://reviewable.io/review_button.png" height=40 alt="Review on Reviewable"/>](https://reviewable.io/reviews/servo/servo/7903)
<!-- Reviewable:end -->
This commit is contained in:
bors-servo 2015-10-07 06:20:20 -06:00
commit 745635a706
1 changed files with 16 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

20
components/script/dom/bindings/codegen/CodegenRust.py
View file

@ -2064,10 +2064,12 @@ class CGAbstractMethod(CGThing):
If templateArgs is not None it should be a list of strings containing If templateArgs is not None it should be a list of strings containing
template arguments, and the function will be templatized using those template arguments, and the function will be templatized using those
arguments. arguments.
docs is None or documentation for the method in a string.
""" """
def __init__(self, descriptor, name, returnType, args, inline=False, def __init__(self, descriptor, name, returnType, args, inline=False,
alwaysInline=False, extern=False, pub=False, templateArgs=None, alwaysInline=False, extern=False, pub=False, templateArgs=None,
unsafe=False): unsafe=False, docs=None):
CGThing.__init__(self) CGThing.__init__(self)
self.descriptor = descriptor self.descriptor = descriptor
self.name = name self.name = name
@ -2078,6 +2080,7 @@ class CGAbstractMethod(CGThing):
self.templateArgs = templateArgs self.templateArgs = templateArgs
self.pub = pub self.pub = pub
self.unsafe = unsafe self.unsafe = unsafe
self.docs = docs
def _argstring(self): def _argstring(self):
return ', '.join([a.declare() for a in self.args]) return ', '.join([a.declare() for a in self.args])
@ -2087,6 +2090,13 @@ class CGAbstractMethod(CGThing):
return '' return ''
return '<%s>\n' % ', '.join(self.templateArgs) return '<%s>\n' % ', '.join(self.templateArgs)
def _docs(self):
if self.docs is None:
return ''
lines = self.docs.splitlines()
return ''.join('/// %s\n' % line for line in lines)
def _decorators(self): def _decorators(self):
decorators = [] decorators = []
if self.alwaysInline: if self.alwaysInline:
@ -2118,8 +2128,9 @@ class CGAbstractMethod(CGThing):
post=self.definition_epilogue()).define() post=self.definition_epilogue()).define()
def definition_prologue(self): def definition_prologue(self):
return "%sfn %s%s(%s)%s {\n" % (self._decorators(), self.name, self._template(), return "%s%sfn %s%s(%s)%s {\n" % (self._docs(), self._decorators(),
self._argstring(), self._returnType()) self.name, self._template(),
self._argstring(), self._returnType())
def definition_epilogue(self): def definition_epilogue(self):
return "\n}\n" return "\n}\n"
@ -4971,8 +4982,9 @@ class CGRegisterProtos(CGAbstractMethod):
class CGRegisterProxyHandlersMethod(CGAbstractMethod): class CGRegisterProxyHandlersMethod(CGAbstractMethod):
def __init__(self, descriptors): def __init__(self, descriptors):
docs = "Create the global vtables used by the generated DOM bindings to implement JS proxies."
CGAbstractMethod.__init__(self, None, 'RegisterProxyHandlers', 'void', [], CGAbstractMethod.__init__(self, None, 'RegisterProxyHandlers', 'void', [],
unsafe=True, pub=True) unsafe=True, pub=True, docs=docs)
self.descriptors = descriptors self.descriptors = descriptors
def definition_body(self): def definition_body(self):