[Groonga-commit] groonga/groonga at 70452a5 [master] doc: add grn_plugin_windows_base_dir()

Back to archive index

Kouhei Sutou null+****@clear*****
Mon Oct 26 23:12:59 JST 2015


Kouhei Sutou	2015-10-26 23:12:59 +0900 (Mon, 26 Oct 2015)

  New Revision: 70452a5916ddd103508003bccfc65970b8083ad6
  https://github.com/groonga/groonga/commit/70452a5916ddd103508003bccfc65970b8083ad6

  Message:
    doc: add grn_plugin_windows_base_dir()

  Modified files:
    doc/source/reference/api/plugin.rst

  Modified: doc/source/reference/api/plugin.rst (+16 -5)
===================================================================
--- doc/source/reference/api/plugin.rst    2015-10-26 14:55:34 +0900 (ccbf591)
+++ doc/source/reference/api/plugin.rst    2015-10-26 23:12:59 +0900 (ee6ca0b)
@@ -104,11 +104,22 @@ Reference
 
 .. c:function:: const char *grn_plugin_win32_base_dir(void)
 
-   grn_plugin_win32_base_dir() returns the groonga install directory.
-   The install directory is computed from the directory that has
-   `groonga.dll`. You can use the directory to generate install
-   directory aware path.
-   It only works on Windows. It returns `NULL` on other platforms.
+   .. deprecated:: 5.0.9. Use :c:func:`grn_plugin_windows_base_dir()`
+                   instead.
+
+   It returns the Groonga install directory. The install directory is
+   computed from the directory that has ``groonga.dll``. You can use
+   the directory to generate install directory aware path. It only
+   works on Windows. It returns ``NULL`` on other platforms.
+
+.. c:function:: const char *grn_plugin_windows_base_dir(void)
+
+   .. versionadded:: 5.0.9
+
+   It returns the Groonga install directory. The install directory is
+   computed from the directory that has ``groonga.dll``. You can use
+   the directory to generate install directory aware path. It only
+   works on Windows. It returns ``NULL`` on other platforms.
 
 .. c:function:: int grn_plugin_charlen(grn_ctx *ctx, const char *str_ptr, unsigned int str_length, grn_encoding encoding)
 
-------------- next part --------------
HTML����������������������������...
Download 



More information about the Groonga-commit mailing list
Back to archive index