[Github-comments] [geany] Gtkdoc hdr (#890)

Thomas Martitz notifications at xxxxx
Fri Feb 19 15:04:23 UTC 2016


> +        proc = DoxygenProcess()
> +        self.brief = proc.process_element(xml)
> +        self.extra += proc.get_extra()
> +
> +    def add_detail(self, xml):
> +        proc = DoxygenProcess()
> +        self.detail = proc.process_element(xml)
> +        self.extra += proc.get_extra()
> +        self.since = proc.get_since()
> +
> +    def add_member(self, xml):
> +        name = xml.find("name").text
> +        proc = DoxygenProcess()
> +        brief = proc.process_element(xml.find("briefdescription"))
> +        # optional doxygen command output appears within <detaileddescription />
> +        proc.process_element(xml.find("detaileddescription"))

Members are usually commented after the semicolon. In this case there is only a briefdescription. They can also be commented like functions in which case annotations are expected in the detaildescription (I'm not sure we have any of these currently?).

---
Reply to this email directly or view it on GitHub:
https://github.com/geany/geany/pull/890/files#r53470752
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.geany.org/pipermail/github-comments/attachments/20160219/24a51738/attachment.html>


More information about the Github-comments mailing list