[Bug tree-optimization/13756] [tree-ssa] documentation missing

[jsm28 at gcc dot gnu dot org]

------- Additional Comments From jsm28 at gcc dot gnu dot org  2004-08-13 10:08 -------
Functions without comments above them:

gimple-low.c: lower_return_expr

gimplify.c: gimple_push_bind_expr gimple_pop_bind_expr gimple_current_bind_expr
get_formal_tmp_var gimple_add_tmp_var annotate_one_with_locus
annotate_all_with_locus unmark_visited_r gimplify_case_label_expr
shortcut_cond_expr

tree-alias-ander.c: get_ref pta_make_lam print_out_result

tree-alias-common.c: alias_get_name

tree-alias-type.c: alias_var_new_with_aterm

tree-browser.c: TB_current_chain_node

tree-cfg.c: execute_build_cfg remove_useless_stmts_cond remove_useless_stmts_tf
remove_useless_stmts_tc remove_useless_stmts_bind remove_useless_stmts_goto
remove_useless_stmts_label remove_useless_stmts_1 remove_useless_stmts
compute_dominance_frontiers tree_purge_dead_eh_edges
tree_purge_all_dead_eh_edges

Many more files not checked, but you get the idea.  All functions must
have comments above them describing what the function does, all its
parameters, and its return value if any.  A reasonable approximation to
a list of undocumented functions in a file can be obtained with

perl -ne 'if (/^\/\*/) { $sc = 1; }; if (/^}\n$/) { $sc = 0; }; if (/^[a-z]/ &&
!$sc) { print $_; }' <source-file.c

-- 


http://gcc.gnu.org/bugzilla/show_bug.cgi?id=13756