(md, method, class_key)
| 297 | |
| 298 | |
| 299 | def add_doc_method(md, method, class_key): |
| 300 | method_name = method['def_name'] |
| 301 | method_key = join([class_key, method_name], '.') |
| 302 | method_def = gen_doc_method_def(method, False) |
| 303 | md.list_pushn(join([html_key(method_key), method_def])) |
| 304 | |
| 305 | # Method doc |
| 306 | if valid_dic_val(method, 'doc'): |
| 307 | md.textn(create_hyperlinks(md.prettify_doc(method['doc']))) |
| 308 | |
| 309 | printed_title = False |
| 310 | if valid_dic_val(method, 'params'): |
| 311 | for param in method['params']: |
| 312 | # is_self = valid_dic_val(param, 'param_name') and param['param_name'] == 'self' |
| 313 | have_doc = valid_dic_val(param, 'doc') |
| 314 | have_type = valid_dic_val(param, 'type') |
| 315 | if not have_doc and not have_type: |
| 316 | continue |
| 317 | # Print the 'Parameters' title once |
| 318 | if not printed_title: |
| 319 | printed_title = True |
| 320 | md.list_push(bold('Parameters:') + '\n') |
| 321 | add_doc_method_param(md, param) |
| 322 | if printed_title: |
| 323 | md.list_pop() |
| 324 | |
| 325 | # Return doc |
| 326 | if valid_dic_val(method, 'return'): |
| 327 | md.list_push(bold('Return:') + ' ') |
| 328 | md.textn(italic(create_hyperlinks(method['return']))) |
| 329 | md.list_pop() |
| 330 | |
| 331 | # Note doc |
| 332 | if valid_dic_val(method, 'note'): |
| 333 | md.list_push(bold('Note:') + ' ') |
| 334 | md.textn(color(COLOR_NOTE, italic(create_hyperlinks(method['note'])))) |
| 335 | md.list_pop() |
| 336 | |
| 337 | # Warning doc |
| 338 | if valid_dic_val(method, 'warning'): |
| 339 | md.list_push(bold('Warning:') + ' ') |
| 340 | md.textn(color(COLOR_WARNING, italic(create_hyperlinks(method['warning'])))) |
| 341 | md.list_pop() |
| 342 | |
| 343 | # Raises error doc |
| 344 | if valid_dic_val(method, 'raises'): |
| 345 | md.list_pushn(bold('Raises:') + ' ' + method['raises']) |
| 346 | md.list_pop() |
| 347 | |
| 348 | md.list_pop() |
| 349 | |
| 350 | |
| 351 | def add_doc_inst_var(md, inst_var, class_key): |
no test coverage detected