Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Documentation fixes #3980

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 20, 2016
Merged

Documentation fixes #3980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8d2784d
describe: fix documentation
tiennou Nov 1, 2016
2adac91
remote: unused function typedef
tiennou Nov 1, 2016
788fcdb
remote: fix documentation and indent
tiennou Nov 1, 2016
8d400c0
transaction: fix documentation
tiennou Nov 1, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions include/git2/describe.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ typedef enum {
typedef struct git_describe_options {
unsigned int version;

unsigned int max_candidates_tags; /** default: 10 */
unsigned int describe_strategy; /** default: GIT_DESCRIBE_DEFAULT */
unsigned int max_candidates_tags; /**< default: 10 */
unsigned int describe_strategy; /**< default: GIT_DESCRIBE_DEFAULT */
const char *pattern;
/**
* When calculating the distance from the matching tag or
Expand Down Expand Up @@ -105,6 +105,9 @@ typedef struct {

GIT_EXTERN(int) git_describe_init_format_options(git_describe_format_options *opts, unsigned int version);

/**
* A struct that stores the result of a describe operation.
*/
typedef struct git_describe_result git_describe_result;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The opaqueness is not something we need to specify in the text.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will fix.


/**
Expand Down
6 changes: 3 additions & 3 deletions include/git2/remote.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,6 @@
*/
GIT_BEGIN_DECL

typedef int (*git_remote_rename_problem_cb)(const char *problematic_refspec, void *payload);

/**
* Add a remote with the default fetch refspec to the repository's configuration.
*
Expand Down Expand Up @@ -360,6 +358,8 @@ typedef struct {
} git_push_update;

/**
* Callback used to inform of upcoming updates.
*
* @param updates an array containing the updates which will be sent
* as commands to the destination.
* @param len number of elements in `updates`
Expand Down Expand Up @@ -403,7 +403,7 @@ struct git_remote_callbacks {
* connection to proceed. Returns 1 to allow the connection, 0
* to disallow it or a negative value to indicate an error.
*/
git_transport_certificate_check_cb certificate_check;
git_transport_certificate_check_cb certificate_check;

/**
* During the download of new data, this will be regularly
Expand Down
9 changes: 9 additions & 0 deletions include/git2/transaction.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@
#define INCLUDE_git_transaction_h__

#include "common.h"

/**
* @file git2/transaction.h
* @brief Git transactional reference routines
* @defgroup git_transaction Git transactional reference routines
* @ingroup Git
* @{
*/
GIT_BEGIN_DECL

/**
Expand Down Expand Up @@ -107,5 +115,6 @@ GIT_EXTERN(int) git_transaction_commit(git_transaction *tx);
*/
GIT_EXTERN(void) git_transaction_free(git_transaction *tx);

/** @} */
GIT_END_DECL
#endif