Revision: 5652 http://geany.svn.sourceforge.net/geany/?rev=5652&view=rev Author: colombanw Date: 2011-03-29 23:52:03 +0000 (Tue, 29 Mar 2011)
Log Message: ----------- Fix a few Doxygen warnings
Modified Paths: -------------- trunk/ChangeLog trunk/doc/pluginsymbols.c trunk/src/sciwrappers.c
Modified: trunk/ChangeLog =================================================================== --- trunk/ChangeLog 2011-03-29 23:20:29 UTC (rev 5651) +++ trunk/ChangeLog 2011-03-29 23:52:03 UTC (rev 5652) @@ -8,6 +8,8 @@ removed when unloading the plugin, preventing possible crashes. * plugins/splitwindow.c: Use new plugin_idle_add(), preventing an unlikely crash. + * doc/pluginsymbols.c, src/sciwrappers.c: + Fix a few Doxygen warnings.
2011-03-29 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
Modified: trunk/doc/pluginsymbols.c =================================================================== --- trunk/doc/pluginsymbols.c 2011-03-29 23:20:29 UTC (rev 5651) +++ trunk/doc/pluginsymbols.c 2011-03-29 23:52:03 UTC (rev 5652) @@ -43,7 +43,7 @@ * @param info The data struct which should be initialized by this function. */ void plugin_set_info(PluginInfo *info);
-/** @deprecated Use @ref geany_plugin->info instead. +/** @deprecated Use @ref GeanyPlugin.info instead. * Basic information about a plugin, which is set in plugin_set_info(). */ const PluginInfo *plugin_info;
Modified: trunk/src/sciwrappers.c =================================================================== --- trunk/src/sciwrappers.c 2011-03-29 23:20:29 UTC (rev 5651) +++ trunk/src/sciwrappers.c 2011-03-29 23:52:03 UTC (rev 5652) @@ -357,7 +357,8 @@
/** Gets the line number from @a position. * @param sci Scintilla widget. - * @param position Position. */ + * @param position Position. + * @return The line. */ gint sci_get_line_from_position(ScintillaObject *sci, gint position) { return SSM(sci, SCI_LINEFROMPOSITION, position, 0); @@ -366,7 +367,8 @@
/** Gets the column number relative to the start of the line that @a position is on. * @param sci Scintilla widget. - * @param position Position. */ + * @param position Position. + * @return The column. */ gint sci_get_col_from_position(ScintillaObject *sci, gint position) { return SSM(sci, SCI_GETCOLUMN, position, 0); @@ -419,7 +421,8 @@
/** Gets the total number of lines. - * @param sci Scintilla widget. */ + * @param sci Scintilla widget. + * @return The line count. */ gint sci_get_line_count(ScintillaObject *sci) { return SSM(sci, SCI_GETLINECOUNT, 0, 0); @@ -451,8 +454,9 @@
/** Gets the position at the end of a line - * @param sci Scintilla widget - * @param line Line */ + * @param sci Scintilla widget. + * @param line Line. + * @return The position at the end of the line. */ gint sci_get_line_end_position(ScintillaObject *sci, gint line) { return SSM(sci, SCI_GETLINEENDPOSITION, line, 0);
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.