diff options
| author | Hiroshi Sumita <hsumita@chromium.org> | 2012-05-21 22:00:48 +0900 |
|---|---|---|
| committer | Hiroshi Sumita <hsumita@chromium.org> | 2012-05-21 22:00:48 +0900 |
| commit | 793f70ba103d78a4deae2b38a4e23ddbbe91ec13 (patch) | |
| tree | 5c31b55e32fac153a643778223391ca71ee8139c | |
| parent | 155a5a8b569fb430715e26f68c9b76d2bc0d0c74 (diff) | |
| download | pyzy-793f70ba103d78a4deae2b38a4e23ddbbe91ec13.tar.gz | |
Fixes some error related to API documents.
BUG=Some documents are wrong.
TEST=Manual
Review URL: https://codereview.appspot.com/6227043
| -rw-r--r-- | docs/Makefile.am | 8 | ||||
| -rw-r--r-- | src/PyZyInputContext.h | 4 | ||||
| -rw-r--r-- | src/PyZyVariant.h | 5 |
3 files changed, 5 insertions, 12 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index a5d4140..39e0e86 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -20,11 +20,6 @@ # USA if HAVE_DOXYGEN -directory = $(top_srcdir)/docs/man/man3/ - -dist_man_MANS = $(directory)/man_page_1.3 $(directory)/man_page_2.3 -$(directory)/man_page_1.3: doxyfile.stamp -$(directory)/man_page_2.3: doxyfile.stamp doxyfile.stamp: $(DOXYGEN) Doxyfile @@ -33,6 +28,7 @@ doxyfile.stamp: CLEANFILES = doxyfile.stamp all-local: doxyfile.stamp + clean-local: - rm -rf $(top_srcdir)/docs/man + rm -rf $(top_srcdir)/docs/html endif diff --git a/src/PyZyInputContext.h b/src/PyZyInputContext.h index 2d2217c..40b94db 100644 --- a/src/PyZyInputContext.h +++ b/src/PyZyInputContext.h @@ -301,14 +301,12 @@ public: /** * \brief Focuses a previous candidate. - * @param index Index of the candidate. (0-origin) * @return true if focused index is changed. */ virtual bool focusCandidatePrevious (void) = 0; /** * \brief Focuses a next candidate. - * @param index Index of the candidate. (0-origin) * @return true if there are some candidates after the focused candidate; * false otherwise. */ @@ -446,7 +444,7 @@ public: /** * \brief Sets property of the context. * @param name you want to get. - * @variant value of the property. + * @param variant value of the property. * @return true if the value is set successfully. */ virtual bool setProperty (PropertyName name, const Variant &variant)= 0; diff --git a/src/PyZyVariant.h b/src/PyZyVariant.h index e4193c1..c48b05e 100644 --- a/src/PyZyVariant.h +++ b/src/PyZyVariant.h @@ -43,21 +43,20 @@ public: /** * \brief Creates a Variant object from the argument. - * @value boolean value. + * @param value boolean value. * @return Variant object. */ static Variant fromBool (bool value); /** * \brief Creates a Variant object from the argument. - * @value unsigned int value. + * @param value unsigned int value. * @return Variant object. */ static Variant fromUnsignedInt (unsigned int value); /** * \brief Creates a null Variant object. - * @value unsigned int value. * @return Variant object. */ static Variant nullVariant (void); |