11using System ;
22using System . Runtime . InteropServices ;
3+
34namespace LibGit2Sharp . Core
45{
56 /// <summary>
@@ -34,10 +35,10 @@ internal class GitFilter
3435
3536 /// <summary>
3637 /// Initialize callback on filter
37- ///
38+ ///
3839 /// Specified as `filter.initialize`, this is an optional callback invoked
3940 /// before a filter is first used. It will be called once at most.
40- ///
41+ ///
4142 /// If non-NULL, the filter's `initialize` callback will be invoked right
4243 /// before the first use of the filter, so you can defer expensive
4344 /// initialization operations (in case libgit2 is being used in a way that doesn't need the filter).
@@ -46,7 +47,7 @@ internal class GitFilter
4647
4748 /// <summary>
4849 /// Shutdown callback on filter
49- ///
50+ ///
5051 /// Specified as `filter.shutdown`, this is an optional callback invoked
5152 /// when the filter is unregistered or when libgit2 is shutting down. It
5253 /// will be called once at most and should release resources as needed.
@@ -57,28 +58,28 @@ internal class GitFilter
5758 /// <summary>
5859 /// Callback to decide if a given source needs this filter
5960 /// 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
61+ ///
62+ /// It should return 0 if the filter should be applied (i.e. success), GIT_PASSTHROUGH if the filter should
6263 /// not be applied, or an error code to fail out of the filter processing pipeline and return to the caller.
63- ///
64+ ///
6465 /// 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
66+ ///
67+ /// The `payload` will be a pointer to a reference payload for the filter. This will start as NULL, but `check` can assign to this
6768 /// 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`
69+ /// away before the `apply` callback can use it. If a filter allocates and assigns a value to the `payload`, it will need a `cleanup`
6970 /// callback to free the payload.
7071 /// </summary>
7172 public delegate int git_filter_check_fn (
7273 GitFilter gitFilter , IntPtr payload , IntPtr filterSource , IntPtr attributeValues ) ;
7374
7475 /// <summary>
7576 /// Callback to actually perform the data filtering
76- ///
77- /// Specified as `filter.apply`, this is the callback that actually filters data.
77+ ///
78+ /// Specified as `filter.apply`, this is the callback that actually filters data.
7879 /// 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.
80+ /// it can return GIT_PASSTHROUGH to indicate that the filter doesn't want to run.
8081 /// Other error codes will stop filter processing and return to the caller.
81- ///
82+ ///
8283 /// 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.
8384 /// </summary>
8485 public delegate int git_filter_apply_fn (
@@ -89,7 +90,7 @@ public delegate int git_filter_stream_fn(
8990
9091 /// <summary>
9192 /// 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`
93+ /// after the filter has been applied. If the `check` or `apply` callbacks allocated a `payload`
9394 /// to keep per-source filter state, use this callback to free that payload and release resources as required.
9495 /// </summary>
9596 public delegate void git_filter_cleanup_fn ( IntPtr gitFilter , IntPtr payload ) ;
0 commit comments