[gmime] Improved docs for GMimeFilterBest - still no vapi binding generated. WTF?



commit d3cab44cf0d0d31356f237e64c39cd7f1578afde
Author: Jeffrey Stedfast <jestedfa microsoft com>
Date:   Tue Nov 27 09:13:05 2018 -0500

    Improved docs for GMimeFilterBest - still no vapi binding generated. WTF?

 gmime/gmime-filter-best.c | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)
---
diff --git a/gmime/gmime-filter-best.c b/gmime/gmime-filter-best.c
index 208bf2f8..ab977fc5 100644
--- a/gmime/gmime-filter-best.c
+++ b/gmime/gmime-filter-best.c
@@ -255,13 +255,14 @@ g_mime_filter_best_new (GMimeFilterBestFlags flags)
 
 /**
  * g_mime_filter_best_charset:
- * @best: best filter
+ * @best: a #GMimeFilterBest
  *
- * Calculates the best charset for encoding the stream filtered
+ * Calculates the best charset for encoding the content filtered
  * through the @best filter.
  *
- * Returns: a pointer to a string containing the name of the charset
- * best suited for the text filtered through @best.
+ * Returns: the name of the charset most suitable for encoding
+ * the content that has been passed through the filter or %NULL
+ * if the filter was not configured to detect this.
  **/
 const char *
 g_mime_filter_best_charset (GMimeFilterBest *best)
@@ -285,10 +286,10 @@ g_mime_filter_best_charset (GMimeFilterBest *best)
  * @constraint: a #GMimeEncodingConstraint
  *
  * Calculates the most efficient Content-Transfer-Encoding for the
- * stream filtered through @best that fits within the encoding
+ * content filtered through @best that fits within the encoding
  * @constraint.
  *
- * Returns: the best encoding for the stream filtered by @best.
+ * Returns: the best encoding for the content filtered by @best.
  **/
 GMimeContentEncoding
 g_mime_filter_best_encoding (GMimeFilterBest *best, GMimeEncodingConstraint constraint)


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]