diff options
author | Benjamin C Meyer <ben@meyerhome.net> | 2010-10-25 22:26:14 -0700 |
---|---|---|
committer | Benjamin C Meyer <ben@meyerhome.net> | 2010-10-25 22:32:52 -0700 |
commit | 0d95f32c55a18303a87147467ebd68ea24995753 (patch) | |
tree | 3338236523d2c8b5b1a5ae1f72187fee685da096 /src | |
parent | 0037e4919bcb53f7441a18c992d0cc70e8d1d931 (diff) | |
download | libgit2-0d95f32c55a18303a87147467ebd68ea24995753.tar.gz |
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>
Diffstat (limited to 'src')
-rw-r--r-- | src/git/commit.h | 12 | ||||
-rw-r--r-- | src/git/common.h | 2 | ||||
-rw-r--r-- | src/git/repository.h | 4 | ||||
-rw-r--r-- | src/git/tag.h | 2 | ||||
-rw-r--r-- | src/git/tree.h | 2 |
5 files changed, 11 insertions, 11 deletions
diff --git a/src/git/commit.h b/src/git/commit.h index 6b5f98fac..308f30f35 100644 --- a/src/git/commit.h +++ b/src/git/commit.h @@ -30,7 +30,7 @@ typedef struct git_commit git_commit; */ GIT_EXTERN(git_commit *) git_commit_lookup(git_repository *repo, const git_oid *id); -/* +/** * Create a new in-memory git_commit. * * The commit object must be manually filled using @@ -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); -/* +/** * Add a new parent commit to an existing commit * @param commit the commit object * @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); -/* +/** * Set the message of a commit * @param commit the commit object * @param message the new message */ GIT_EXTERN(void) git_commit_set_message(git_commit *commit, const char *message); -/* +/** * Set the committer of a commit * @param commit the commit object * @param committer the new committer */ GIT_EXTERN(void) git_commit_set_committer(git_commit *commit, const git_person *committer); -/* +/** * Set the author of a commit * @param commit the commit object * @param author the new 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 * @param commit the commit object * @param tree the new tree diff --git a/src/git/common.h b/src/git/common.h index 2385df9dd..6d4858d71 100644 --- a/src/git/common.h +++ b/src/git/common.h @@ -91,7 +91,7 @@ GIT_BEGIN_DECL */ 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; /** Parsed representation of a person */ diff --git a/src/git/repository.h b/src/git/repository.h index b47400b7d..9658989b4 100644 --- a/src/git/repository.h +++ b/src/git/repository.h @@ -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); -/* +/** * Create a new in-memory repository object with * the given type. * @@ -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); -/* +/** * Write back an object to disk. * * The object will be written to its corresponding diff --git a/src/git/tag.h b/src/git/tag.h index 686f4cf67..f9431db32 100644 --- a/src/git/tag.h +++ b/src/git/tag.h @@ -29,7 +29,7 @@ typedef struct git_tag git_tag; */ GIT_EXTERN(git_tag *) git_tag_lookup(git_repository *repo, const git_oid *id); -/* +/** * Create a new in-memory git_tag. * * The tag object must be manually filled using diff --git a/src/git/tree.h b/src/git/tree.h index 1726af2ab..190fe95d6 100644 --- a/src/git/tree.h +++ b/src/git/tree.h @@ -32,7 +32,7 @@ typedef struct git_tree git_tree; */ GIT_EXTERN(git_tree *) git_tree_lookup(git_repository *repo, const git_oid *id); -/* +/** * Create a new in-memory git_tree. * * The tree object must be manually filled using |