Skip to content

Commit fc02354

Browse files
committed
Fix docstyle in dump_c.cpp
Must have got missed out of the global Doxygenification somehow. No functional changes.
1 parent 123162b commit fc02354

File tree

1 file changed

+15
-59
lines changed

1 file changed

+15
-59
lines changed

src/goto-instrument/dump_c.cpp

+15-59
Original file line numberDiff line numberDiff line change
@@ -631,45 +631,24 @@ void dump_ct::cleanup_decl(
631631
decl.swap(b.op0());
632632
}
633633

634-
/*******************************************************************\
635-
636-
Function: dump_ct::collect_typedefs
637-
638-
Inputs:
639-
type Type to inspect for ID_C_typedef entry
640-
early Set to true to enforce that typedef is dumped before any
641-
function declarations or struct definitions
642-
643-
Outputs:
644-
645-
Purpose: Find any typedef names contained in the input type and store
646-
their declaration strings in typedef_map for eventual output.
647-
648-
\*******************************************************************/
649-
634+
/// Find any typedef names contained in the input type and store their
635+
/// declaration strings in typedef_map for eventual output.
636+
/// \param type: type to inspect for ID_C_typedef entry
637+
/// \param early: set to true to enforce that typedef is dumped before any
638+
/// function declarations or struct definitions
650639
void dump_ct::collect_typedefs(const typet &type, bool early)
651640
{
652641
std::unordered_set<irep_idt, irep_id_hash> deps;
653642
collect_typedefs_rec(type, early, deps);
654643
}
655644

656-
/*******************************************************************\
657-
658-
Function: dump_ct::collect_typedefs_rec
659-
660-
Inputs:
661-
type Type to inspect for ID_C_typedef entry
662-
early Set to true to enforce that typedef is dumped before any
663-
function declarations or struct definitions
664-
dependencies Typedefs used in the declaration of a given typedef
665-
666-
Outputs:
667-
668-
Purpose: Find any typedef names contained in the input type and store
669-
their declaration strings in typedef_map for eventual output.
670-
671-
\*******************************************************************/
672-
645+
/// Find any typedef names contained in the input type and store their
646+
/// declaration strings in typedef_map for eventual output.
647+
/// \param type: type to inspect for ID_C_typedef entry
648+
/// \param early: set to true to enforce that typedef is dumped before any
649+
/// function declarations or struct definitions
650+
/// \param [out] dependencies: typedefs used in the declaration of a given
651+
/// typedef
673652
void dump_ct::collect_typedefs_rec(
674653
const typet &type,
675654
bool early,
@@ -745,19 +724,7 @@ void dump_ct::collect_typedefs_rec(
745724
dependencies.insert(local_deps.begin(), local_deps.end());
746725
}
747726

748-
/*******************************************************************\
749-
750-
Function: dump_ct::gather_global_typedefs
751-
752-
Inputs:
753-
754-
Outputs:
755-
756-
Purpose: find all global typdefs in the symbol table and store them
757-
in typedef_types
758-
759-
\*******************************************************************/
760-
727+
/// Find all global typdefs in the symbol table and store them in typedef_types
761728
void dump_ct::gather_global_typedefs()
762729
{
763730
// sort the symbols first to ensure deterministic replacement in
@@ -787,19 +754,8 @@ void dump_ct::gather_global_typedefs()
787754
}
788755
}
789756

790-
/*******************************************************************\
791-
792-
Function: dump_ct::dump_typedefs
793-
794-
Inputs:
795-
796-
Outputs: os output stream
797-
798-
Purpose: print all typedefs that are not covered via
799-
typedef struct xyz { ... } name;
800-
801-
\*******************************************************************/
802-
757+
/// Print all typedefs that are not covered via typedef struct xyz { ... } name;
758+
/// \param [out] os: output stream
803759
void dump_ct::dump_typedefs(std::ostream &os) const
804760
{
805761
// we need to compute a topological sort; we do so by picking all

0 commit comments

Comments
 (0)