Skip to content

Commit

Permalink
Adding linked list data structures to the documentaiton.
Browse files Browse the repository at this point in the history
 On branch master
 Your branch is up-to-date with 'github/master'.

 Changes to be committed:
	new file:   ../docs/ast-utility.dox
	modified:   ../src/verilog_ast_common.h
  • Loading branch information
ben-marshall committed May 30, 2016
1 parent dfcbd82 commit a1eab30
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/ast-utility.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/*!
@defgroup ast-utility AST Utility Functions
@ingroup ast

@brief Contains utility data structures and functions which are used to
help represent portions of the AST, but which are not specific to a
particular node.

*/
9 changes: 9 additions & 0 deletions src/verilog_ast_common.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@

// --------------- Linked List ------------------------

/*!
@defgroup ast-linked-lists Linked List
@{
@ingroup ast-utility
*/


//! Typedef for the ast_list_element_t
typedef struct ast_list_element_t ast_list_element;

Expand Down Expand Up @@ -60,4 +67,6 @@ void ast_list_append(ast_list * list, void * data);
*/
void ast_list_preappend(ast_list * list, void * data);

/*! @} */

#endif

0 comments on commit a1eab30

Please sign in to comment.