Commit 0d95f32c55a18303a87147467ebd68ea24995753
2010-10-25T22:26:14
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>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
diff --git a/src/git/commit.h b/src/git/commit.h
index 6b5f98f..308f30f 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 2385df9..6d4858d 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 b47400b..9658989 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 686f4cf..f9431db 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 1726af2..190fe95 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