@@ -34,10 +34,10 @@ internal class GitFilter
34
34
35
35
/// <summary>
36
36
/// Initialize callback on filter
37
- ///
37
+ ///
38
38
/// Specified as `filter.initialize`, this is an optional callback invoked
39
39
/// before a filter is first used. It will be called once at most.
40
- ///
40
+ ///
41
41
/// If non-NULL, the filter's `initialize` callback will be invoked right
42
42
/// before the first use of the filter, so you can defer expensive
43
43
/// initialization operations (in case libgit2 is being used in a way that doesn't need the filter).
@@ -46,7 +46,7 @@ internal class GitFilter
46
46
47
47
/// <summary>
48
48
/// Shutdown callback on filter
49
- ///
49
+ ///
50
50
/// Specified as `filter.shutdown`, this is an optional callback invoked
51
51
/// when the filter is unregistered or when libgit2 is shutting down. It
52
52
/// will be called once at most and should release resources as needed.
@@ -57,28 +57,28 @@ internal class GitFilter
57
57
/// <summary>
58
58
/// Callback to decide if a given source needs this filter
59
59
/// Specified as `filter.check`, this is an optional callback that checks if filtering is needed for a given source.
60
- ///
61
- /// It should return 0 if the filter should be applied (i.e. success), GIT_PASSTHROUGH if the filter should
60
+ ///
61
+ /// It should return 0 if the filter should be applied (i.e. success), GIT_PASSTHROUGH if the filter should
62
62
/// not be applied, or an error code to fail out of the filter processing pipeline and return to the caller.
63
- ///
63
+ ///
64
64
/// The `attr_values` will be set to the values of any attributes given in the filter definition. See `git_filter` below for more detail.
65
- ///
66
- /// The `payload` will be a pointer to a reference payload for the filter. This will start as NULL, but `check` can assign to this
65
+ ///
66
+ /// The `payload` will be a pointer to a reference payload for the filter. This will start as NULL, but `check` can assign to this
67
67
/// pointer for later use by the `apply` callback. Note that the value should be heap allocated (not stack), so that it doesn't go
68
- /// away before the `apply` callback can use it. If a filter allocates and assigns a value to the `payload`, it will need a `cleanup`
68
+ /// away before the `apply` callback can use it. If a filter allocates and assigns a value to the `payload`, it will need a `cleanup`
69
69
/// callback to free the payload.
70
70
/// </summary>
71
71
public delegate int git_filter_check_fn (
72
72
GitFilter gitFilter , IntPtr payload , IntPtr filterSource , IntPtr attributeValues ) ;
73
73
74
74
/// <summary>
75
75
/// Callback to actually perform the data filtering
76
- ///
77
- /// Specified as `filter.apply`, this is the callback that actually filters data.
76
+ ///
77
+ /// Specified as `filter.apply`, this is the callback that actually filters data.
78
78
/// If it successfully writes the output, it should return 0. Like `check`,
79
- /// it can return GIT_PASSTHROUGH to indicate that the filter doesn't want to run.
79
+ /// it can return GIT_PASSTHROUGH to indicate that the filter doesn't want to run.
80
80
/// Other error codes will stop filter processing and return to the caller.
81
- ///
81
+ ///
82
82
/// The `payload` value will refer to any payload that was set by the `check` callback. It may be read from or written to as needed.
83
83
/// </summary>
84
84
public delegate int git_filter_apply_fn (
@@ -89,7 +89,7 @@ public delegate int git_filter_stream_fn(
89
89
90
90
/// <summary>
91
91
/// Callback to clean up after filtering has been applied. Specified as `filter.cleanup`, this is an optional callback invoked
92
- /// after the filter has been applied. If the `check` or `apply` callbacks allocated a `payload`
92
+ /// after the filter has been applied. If the `check` or `apply` callbacks allocated a `payload`
93
93
/// to keep per-source filter state, use this callback to free that payload and release resources as required.
94
94
/// </summary>
95
95
public delegate void git_filter_cleanup_fn ( IntPtr gitFilter , IntPtr payload ) ;
0 commit comments