Issue 5645095: Fix typoes in gtk-doc comments.

Keyboard Shortcuts

	File
u :	up to issue
m :	publish + mail comments
M :	edit review message
j / k :	jump to file after / before current file
J / K :	jump to next file with a comment after / before current file
	Side-by-side diff
i :	toggle intra-line diffs
e :	expand all comments
c :	collapse all comments
s :	toggle showing all comments
n / p :	next / previous diff chunk or comment
N / P :	next / previous comment
<Up> / <Down> :	next / previous line
<Enter> :	respond to / edit current comment
d :	mark current comment as done

	Issue
u :	up to list of issues
m :	publish + mail comments
j / k :	jump to patch after / before current patch
o / <Enter> :	open current patch in side-by-side view
i :	open current patch in unified diff view

	Issue List
j / k :	jump to issue after / before current issue
o / <Enter> :	open current issue
# :	close issue

	Comment/message editing
<Ctrl> + s or <Ctrl> + Enter :	save comment
<Esc> :	cancel edit

Issue 5645095: Fix typoes in gtk-doc comments. (Closed)

Can't Edit
Can't Publish+Mail
Start Review

Created:
12 years, 2 months ago by Daiki Ueno

Modified:
12 years, 2 months ago

Reviewers:
shawn.p.huang, Peng

Base URL:
git@github.com:ibus/ibus.git@master

Visibility:
Public.

More Reviews

Description

Fix typoes in gtk-doc comments. BUG=none TEST=manually

Patch Set 2 : fix articles #

Total comments: 2

Created: 12 years, 2 months ago

Download [raw] [tar.bz2]

	Unified diffs	Side-by-side diffs	Delta from patch set	Stats (+55 lines, -55 lines)			Patch
M	src/ibusbus.h	View		2 chunks	+3 lines, -3 lines	0 comments	Download
M	src/ibusconfig.h	View		13 chunks	+26 lines, -26 lines	2 comments	Download
M	src/ibusengine.h	View		1 chunk	+2 lines, -2 lines	0 comments	Download
M	src/ibushotkey.h	View		1 chunk	+1 line, -1 line	0 comments	Download
M	src/ibusinputcontext.h	View		2 chunks	+2 lines, -2 lines	0 comments	Download
M	src/ibusserializable.h	View	1	12 chunks	+16 lines, -16 lines	0 comments	Download
M	src/ibusshare.h	View		5 chunks	+5 lines, -5 lines	0 comments	Download

Messages

Total messages: 4

Expand All Messages | Collapse All Messages

Daiki Ueno

note that this patch does not change GI annotations so it can be applied safely

12 years, 2 months ago (2012-02-13 06:42:00 UTC) #1

Peng

LGTM with questions https://codereview.appspot.com/5645095/diff/2001/src/ibusconfig.h File src/ibusconfig.h (right): https://codereview.appspot.com/5645095/diff/2001/src/ibusconfig.h#newcode138 src/ibusconfig.h:138: * See also: ibus_config_set_value(). @see_also is ...

12 years, 2 months ago (2012-02-13 17:15:36 UTC) #2

Daiki Ueno

https://codereview.appspot.com/5645095/diff/2001/src/ibusconfig.h File src/ibusconfig.h (right): https://codereview.appspot.com/5645095/diff/2001/src/ibusconfig.h#newcode138 src/ibusconfig.h:138: * See also: ibus_config_set_value(). On 2012/02/13 17:15:37, Peng wrote: ...

12 years, 2 months ago (2012-02-14 01:21:13 UTC) #3

Peng

12 years, 2 months ago (2012-02-14 01:28:38 UTC) #4

On 2012/02/14 01:21:13, Daiki Ueno wrote:
> https://codereview.appspot.com/5645095/diff/2001/src/ibusconfig.h
> File src/ibusconfig.h (right):
> 
> https://codereview.appspot.com/5645095/diff/2001/src/ibusconfig.h#newcode138
> src/ibusconfig.h:138: * See also: ibus_config_set_value().
> On 2012/02/13 17:15:37, Peng wrote:
> > @see_also is a keyword for gtk-doc
> >
>
http://developer.gnome.org/gtk-doc-manual/unstable/documenting_sections.html.en
> > 
> > You changed it to See also, does it work?
> 
> @see_also is only allowed in section comment block not in function comment
> block:
> http://developer.gnome.org/gtk-doc-manual/unstable/documenting_symbols.html.en
> So, I get "see_also: " in the output HTML if @see_also is used.  @returns,
which
> is also not supported in function comment block, still seems to work though.

I see. thanks for explanation. lgtm

Expand All Messages | Collapse All Messages