Commit 0d95f32c by Benjamin C Meyer

Change /* to /** at the start of comment blocks in public api so doxygen

will generate documenation and not hide them.

Signed-off-by: Benjamin C Meyer <ben@meyerhome.net>
parent 0037e491
...@@ -30,7 +30,7 @@ typedef struct git_commit git_commit; ...@@ -30,7 +30,7 @@ typedef struct git_commit git_commit;
*/ */
GIT_EXTERN(git_commit *) git_commit_lookup(git_repository *repo, const git_oid *id); GIT_EXTERN(git_commit *) git_commit_lookup(git_repository *repo, const git_oid *id);
/* /**
* Create a new in-memory git_commit. * Create a new in-memory git_commit.
* *
* The commit object must be manually filled using * The commit object must be manually filled using
...@@ -91,35 +91,35 @@ GIT_EXTERN(const git_person *) git_commit_author(git_commit *commit); ...@@ -91,35 +91,35 @@ GIT_EXTERN(const git_person *) git_commit_author(git_commit *commit);
*/ */
GIT_EXTERN(const git_tree *) git_commit_tree(git_commit *commit); GIT_EXTERN(const git_tree *) git_commit_tree(git_commit *commit);
/* /**
* Add a new parent commit to an existing commit * Add a new parent commit to an existing commit
* @param commit the commit object * @param commit the commit object
* @param new_parent the new commit which will be a parent * @param new_parent the new commit which will be a parent
*/ */
GIT_EXTERN(void) git_commit_add_parent(git_commit *commit, git_commit *new_parent); GIT_EXTERN(void) git_commit_add_parent(git_commit *commit, git_commit *new_parent);
/* /**
* Set the message of a commit * Set the message of a commit
* @param commit the commit object * @param commit the commit object
* @param message the new message * @param message the new message
*/ */
GIT_EXTERN(void) git_commit_set_message(git_commit *commit, const char *message); GIT_EXTERN(void) git_commit_set_message(git_commit *commit, const char *message);
/* /**
* Set the committer of a commit * Set the committer of a commit
* @param commit the commit object * @param commit the commit object
* @param committer the new committer * @param committer the new committer
*/ */
GIT_EXTERN(void) git_commit_set_committer(git_commit *commit, const git_person *committer); GIT_EXTERN(void) git_commit_set_committer(git_commit *commit, const git_person *committer);
/* /**
* Set the author of a commit * Set the author of a commit
* @param commit the commit object * @param commit the commit object
* @param author the new author * @param author the new author
*/ */
GIT_EXTERN(void) git_commit_set_author(git_commit *commit, const git_person *author); GIT_EXTERN(void) git_commit_set_author(git_commit *commit, const git_person *author);
/* /**
* Set the tree which is pointed to by a commit * Set the tree which is pointed to by a commit
* @param commit the commit object * @param commit the commit object
* @param tree the new tree * @param tree the new tree
......
...@@ -91,7 +91,7 @@ GIT_BEGIN_DECL ...@@ -91,7 +91,7 @@ GIT_BEGIN_DECL
*/ */
typedef struct git_repository git_repository; typedef struct git_repository git_repository;
/* Representation of a generic object in a repository */ /** Representation of a generic object in a repository */
typedef struct git_object git_object; typedef struct git_object git_object;
/** Parsed representation of a person */ /** Parsed representation of a person */
......
...@@ -57,7 +57,7 @@ GIT_EXTERN(git_object *) git_repository_lookup(git_repository *repo, const git_o ...@@ -57,7 +57,7 @@ GIT_EXTERN(git_object *) git_repository_lookup(git_repository *repo, const git_o
*/ */
GIT_EXTERN(git_odb *) git_repository_database(git_repository *repo); GIT_EXTERN(git_odb *) git_repository_database(git_repository *repo);
/* /**
* Create a new in-memory repository object with * Create a new in-memory repository object with
* the given type. * the given type.
* *
...@@ -79,7 +79,7 @@ GIT_EXTERN(git_odb *) git_repository_database(git_repository *repo); ...@@ -79,7 +79,7 @@ GIT_EXTERN(git_odb *) git_repository_database(git_repository *repo);
*/ */
GIT_EXTERN(git_object *) git_object_new(git_repository *repo, git_otype type); GIT_EXTERN(git_object *) git_object_new(git_repository *repo, git_otype type);
/* /**
* Write back an object to disk. * Write back an object to disk.
* *
* The object will be written to its corresponding * The object will be written to its corresponding
......
...@@ -29,7 +29,7 @@ typedef struct git_tag git_tag; ...@@ -29,7 +29,7 @@ typedef struct git_tag git_tag;
*/ */
GIT_EXTERN(git_tag *) git_tag_lookup(git_repository *repo, const git_oid *id); GIT_EXTERN(git_tag *) git_tag_lookup(git_repository *repo, const git_oid *id);
/* /**
* Create a new in-memory git_tag. * Create a new in-memory git_tag.
* *
* The tag object must be manually filled using * The tag object must be manually filled using
......
...@@ -32,7 +32,7 @@ typedef struct git_tree git_tree; ...@@ -32,7 +32,7 @@ typedef struct git_tree git_tree;
*/ */
GIT_EXTERN(git_tree *) git_tree_lookup(git_repository *repo, const git_oid *id); GIT_EXTERN(git_tree *) git_tree_lookup(git_repository *repo, const git_oid *id);
/* /**
* Create a new in-memory git_tree. * Create a new in-memory git_tree.
* *
* The tree object must be manually filled using * The tree object must be manually filled using
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment