def out_doc(self, fname, name, args): if not self.check_doc(name, args): return out_name = self.arg_name(args, name) self.emit_th(out_name, args) for section, text in args.sections.items(): self.data += f'.SH "{section}"' + "\n" self.output_highlight(text) def out_function(self, fname, name, args): out_name = self.arg_name(args, name) self.emit_th(out_name, args) self.data += ".SH NAME\n" self.data += f"{name} \\- {args['purpose']}\n" self.data += ".SH SYNOPSIS\n" if args.get('functiontype', ''): self.data += f'.B "{args["functiontype"]}" {name}' + "\n" else: self.data += f'.B "{name}' + "\n" count = 0 parenth = "(" post = "," for parameter in args.parameterlist: if count == len(args.parameterlist) - 1: post = ");" dtype = args.parametertypes.get(parameter, "") if function_pointer.match(dtype): # Pointer-to-function self.data += f'".BI "{parenth}{function_pointer.group(1)}" " ") ({function_pointer.group(2)}){post}"' + "\n" else: dtype = KernRe(r'([^\*])$').sub(r'\1 ', dtype) self.data += f'.BI "{parenth}{dtype}" "{post}"' + "\n" count += 1 parenth = "" if args.parameterlist: self.data += ".SH ARGUMENTS\n" for parameter in args.parameterlist: parameter_name = re.sub(r'\[.*', '', parameter) self.data += f'.IP "{parameter}" 12' + "\n" self.output_highlight(args.parameterdescs.get(parameter_name, "")) for section, text in args.sections.items(): self.data += f'.SH "{section.upper()}"' + "\n" self.output_highlight(text) def out_enum(self, fname, name, args): out_name = self.arg_name(args, name) self.emit_th(out_name, args) self.data += ".SH NAME\n" self.data += f"enum {name} \\- {args['purpose']}\n" self.data += ".SH SYNOPSIS\n" self.data += f"enum {name}" + " {\n" count = 0 for parameter in args.parameterlist: self.data += f'.br\n.BI " {parameter}"' + "\n" if count == len(args.parameterlist) - 1: self.data += "\n};\n" else: self.data += ", \n.br\n" count += 1 self.data += ".SH Constants\n" for parameter in args.parameterlist: parameter_name = KernRe(r'\[.*').sub('', parameter) self.data += f'.IP "{parameter}" 12' + "\n" self.output_highlight(args.parameterdescs.get(parameter_name, "")) for section, text in args.sections.items(): self.data += f'.SH "{section}"' + "\n" self.output_highlight(text) def out_var(self, fname, name, args): out_name = self.arg_name(args, name) full_proto = args.other_stuff["full_proto"] self.emit_th(out_name, args) self.data += ".SH NAME\n" self.data += f"{name} \\- {args['purpose']}\n" self.data += ".SH SYNOPSIS\n" self.data += f"{full_proto}\n" if args.other_stuff["default_val"]: self.data += f'.SH "Initialization"' + "\n" self.output_highlight(f'default: {args.other_stuff["default_val"]}') for section, text in args.sections.items(): self.data += f'.SH "{section}"' + "\n" self.output_highlight(text) def out_typedef(self, fname, name, args): module = self.modulename(args) purpose = args.get('purpose') out_name = self.arg_name(args, name) self.emit_th(out_name, args) self.data += ".SH NAME\n" self.data += f"typedef {name} \\- {purpose}\n" for section, text in args.sections.items(): self.data += f'.SH "{section}"' + "\n" self.output_highlight(text) def out_struct(self, fname, name, args): module = self.modulename(args) purpose = args.get('purpose') definition = args.get('definition') out_name = self.arg_name(args, name) self.emit_th(out_name, args) self.data += ".SH NAME\n" self.data += f"{args.type} {name} \\- {purpose}\n" # Replace tabs with two spaces and handle newlines declaration = definition.replace("\t", " ") declaration = KernRe(r"\n").sub('"\n.br\n.BI "', declaration) self.data += ".SH SYNOPSIS\n" self.data += f"{args.type} {name} " + "{" + "\n.br\n" self.data += f'.BI "{declaration}\n' + "};\n.br\n\n" self.data += ".SH Members\n" for parameter in args.parameterlist: if parameter.startswith("#"): continue parameter_name = re.sub(r"\[.*", "", parameter) if args.parameterdescs.get(parameter_name) == KernelDoc.undescribed: continue self.data += f'.IP "{parameter}" 12' + "\n" self.output_highlight(args.parameterdescs.get(parameter_name)) for section, text in args.sections.items(): self.data += f'.SH "{section}"' + "\n" self.output_highlight(text)Lines 1001–1160 of 1160. Previous lines
def out_doc(self, fname, name, args): if not self.check_doc(name, args): return out_name = self.arg_name(args, name) self.emit_th(out_name, args) for section, text in args.sections.items(): self.data += f'.SH "{section}"' + "\n" self.output_highlight(text) def out_function(self, fname, name, args): out_name = self.arg_name(args, name) self.emit_th(out_name, args) self.data += ".SH NAME\n" self.data += f"{name} \\- {args['purpose']}\n" self.data += ".SH SYNOPSIS\n" if args.get('functiontype', ''): self.data += f'.B "{args["functiontype"]}" {name}' + "\n" else: self.data += f'.B "{name}' + "\n" count = 0 parenth = "(" post = "," for parameter in args.parameterlist: if count == len(args.parameterlist) - 1: post = ");" dtype = args.parametertypes.get(parameter, "") if function_pointer.match(dtype): # Pointer-to-function self.data += f'".BI "{parenth}{function_pointer.group(1)}" " ") ({function_pointer.group(2)}){post}"' + "\n" else: dtype = KernRe(r'([^\*])$').sub(r'\1 ', dtype) self.data += f'.BI "{parenth}{dtype}" "{post}"' + "\n" count += 1 parenth = "" if args.parameterlist: self.data += ".SH ARGUMENTS\n" for parameter in args.parameterlist: parameter_name = re.sub(r'\[.*', '', parameter) self.data += f'.IP "{parameter}" 12' + "\n" self.output_highlight(args.parameterdescs.get(parameter_name, "")) for section, text in args.sections.items(): self.data += f'.SH "{section.upper()}"' + "\n" self.output_highlight(text) def out_enum(self, fname, name, args): out_name = self.arg_name(args, name) self.emit_th(out_name, args) self.data += ".SH NAME\n" self.data += f"enum {name} \\- {args['purpose']}\n" self.data += ".SH SYNOPSIS\n" self.data += f"enum {name}" + " {\n" count = 0 for parameter in args.parameterlist: self.data += f'.br\n.BI " {parameter}"' + "\n" if count == len(args.parameterlist) - 1: self.data += "\n};\n" else: self.data += ", \n.br\n" count += 1 self.data += ".SH Constants\n" for parameter in args.parameterlist: parameter_name = KernRe(r'\[.*').sub('', parameter) self.data += f'.IP "{parameter}" 12' + "\n" self.output_highlight(args.parameterdescs.get(parameter_name, "")) for section, text in args.sections.items(): self.data += f'.SH "{section}"' + "\n" self.output_highlight(text) def out_var(self, fname, name, args): out_name = self.arg_name(args, name) full_proto = args.other_stuff["full_proto"] self.emit_th(out_name, args) self.data += ".SH NAME\n" self.data += f"{name} \\- {args['purpose']}\n" self.data += ".SH SYNOPSIS\n" self.data += f"{full_proto}\n" if args.other_stuff["default_val"]: self.data += f'.SH "Initialization"' + "\n" self.output_highlight(f'default: {args.other_stuff["default_val"]}') for section, text in args.sections.items(): self.data += f'.SH "{section}"' + "\n" self.output_highlight(text) def out_typedef(self, fname, name, args): module = self.modulename(args) purpose = args.get('purpose') out_name = self.arg_name(args, name) self.emit_th(out_name, args) self.data += ".SH NAME\n" self.data += f"typedef {name} \\- {purpose}\n" for section, text in args.sections.items(): self.data += f'.SH "{section}"' + "\n" self.output_highlight(text) def out_struct(self, fname, name, args): module = self.modulename(args) purpose = args.get('purpose') definition = args.get('definition') out_name = self.arg_name(args, name) self.emit_th(out_name, args) self.data += ".SH NAME\n" self.data += f"{args.type} {name} \\- {purpose}\n" # Replace tabs with two spaces and handle newlines declaration = definition.replace("\t", " ") declaration = KernRe(r"\n").sub('"\n.br\n.BI "', declaration) self.data += ".SH SYNOPSIS\n" self.data += f"{args.type} {name} " + "{" + "\n.br\n" self.data += f'.BI "{declaration}\n' + "};\n.br\n\n" self.data += ".SH Members\n" for parameter in args.parameterlist: if parameter.startswith("#"): continue parameter_name = re.sub(r"\[.*", "", parameter) if args.parameterdescs.get(parameter_name) == KernelDoc.undescribed: continue self.data += f'.IP "{parameter}" 12' + "\n" self.output_highlight(args.parameterdescs.get(parameter_name)) for section, text in args.sections.items(): self.data += f'.SH "{section}"' + "\n" self.output_highlight(text)