Differential D4137

API dox: Add @class comment with CamelCase include, image title without KDE
ClosedPublic
Actions

Authored by kossebau on Jan 15 2017, 12:55 AM.

Details

Reviewers

cfeck

Group Reviewers

Frameworks

Commits

R236:0070f76418c0: API dox: Add @class comment with CamelCase include, image title without KDE

Diff Detail

Repository

R236 KWidgetsAddons

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

kossebau updated this revision to Diff 10171.Jan 15 2017, 12:55 AM

kossebau retitled this revision from to API dox: Add @class comment with CamelCase include, image title without KDE.

kossebau added a reviewer: Frameworks.

Restricted Application added a project: Frameworks. · View Herald TranscriptJan 15 2017, 12:55 AM

cfeck added subscribers: class, cfeck.Jan 15 2017, 2:40 AM

cfeck added inline comments.

src/kselector.h
128	Does probably need a separate @class entry?

kossebau added inline comments.Jan 15 2017, 1:59 PM

src/kselector.h
128	Yes, but... :) There are a few headers which export multiple classes, like this one, but there are no matching CamelCase forward headers yet generated. I was to do this in a separate commit, to not put too much into this one (fixing the image titles already should ideally be a separate commit as well, are another matter).

add @class comments also for all classes in multi-class headers

kossebau removed a subscriber: class.Jan 15 2017, 5:37 PM

https://phabricator.kde.org/D4144 now would create the missing forward headers.

Only issue might be that there is no @since note possible... so people might start using the forward header without knowing in which KF version this forward header was added... possibly something that would need to be catched on the build front ideally, by somehow telling the header which min version of KF is assumed. Still would be nice to give a hint already in the docs. Any idea?

I would just add the missing forwarding headers without mentioning the version they first appeared in. Let's assume it is just a bug fix, and we do not mention bug fixes in the documentation.

cfeck accepted this revision.Jan 16 2017, 1:25 AM

cfeck added a reviewer: cfeck.

This revision is now accepted and ready to land.Jan 16 2017, 1:25 AM

Not perfect, but guess that is all we can do with current buildsystems, okay.
Could you also officially accept D4144 then? :)
Would wait for further feedback until the upcoming WE, and then push both unless someone objects.

Closed by commit R236:0070f76418c0: API dox: Add @class comment with CamelCase include, image title without KDE (authored by kossebau). · Explain WhyJan 19 2017, 6:08 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

			Path	Packages
M			src/kacceleratormanager.h (2 lines)
M			src/kactionmenu.h (2 lines)
M			src/kactionselector.h (4 lines)
M			src/kanimatedbutton.h (2 lines)
M			src/kassistantdialog.h (4 lines)
M			src/kcapacitybar.h (4 lines)
M			src/kcharselect.h (4 lines)
M			src/kcollapsiblegroupbox.h (2 lines)
M			src/kcolorbutton.h (4 lines)
M			src/kcolorcombo.h (4 lines)
M			src/kcolumnresizer.h (2 lines)
M			src/kcursor.h (2 lines)
M			src/kdatecombobox.h (3 lines)
M			src/kdatepicker.h (4 lines)
M			src/kdatetimeedit.h (3 lines)
M			src/kdragwidgetdecorator.h (2 lines)
M			src/kdualaction.h (2 lines)
M			src/keditlistwidget.h (4 lines)
M			src/kfontaction.h (2 lines)
M			src/kfontchooser.h (4 lines)
M			src/kfontrequester.h (4 lines)
M			src/kfontsizeaction.h (2 lines)
M			src/kguiitem.h (2 lines)
M			src/kled.h (4 lines)
M			src/kmessagebox.h (2 lines)
M			src/kmessagewidget.h (2 lines)
M			src/kmimetypechooser.h (4 lines)
M			src/kmultitabbar.h (8 lines)
M			src/knewpassworddialog.h (4 lines)
M			src/knewpasswordwidget.h (2 lines)
M			src/kpagedialog.h (2 lines)
M			src/kpagemodel.h (2 lines)
M			src/kpageview.h (2 lines)
M			src/kpagewidget.h (2 lines)
M			src/kpagewidgetmodel.h (4 lines)
M			src/kpassworddialog.h (4 lines)
M			src/kpixmapregionselectordialog.h (4 lines)
M			src/kpixmapregionselectorwidget.h (4 lines)
M			src/kpopupframe.h (2 lines)
M			src/kratingpainter.h (2 lines)
M			src/kratingwidget.h (2 lines)
M			src/kruler.h (4 lines)
M			src/kselectaction.h (2 lines)
M			src/kselector.h (6 lines)
M			src/kseparator.h (6 lines)
M			src/ksplittercollapserbutton.h (2 lines)
M			src/ksqueezedtextlabel.h (2 lines)
M			src/ktimecombobox.h (3 lines)
M			src/ktitlewidget.h (2 lines)
M			src/ktoggleaction.h (2 lines)
M			src/ktogglefullscreenaction.h (2 lines)
M			src/ktoolbarlabelaction.h (2 lines)
M			src/ktoolbarpopupaction.h (2 lines)
M			src/ktoolbarspaceraction.h (2 lines)
M			src/ktooltipwidget.h (2 lines)
M			src/kurllabel.h (4 lines)
M			src/kviewstateserializer.h (2 lines)
M			src/kxyselector.h (2 lines)
M			src/lineediturldropeventfilter.h (2 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	10171	165812c		Jan 15 2017, 12:55 AM	★	★
Diff 2	10189	165812c	add @class comments also for all classes in multi-class headers	Jan 15 2017, 5:32 PM	★	★
Diff 3	10361	1473382	R236:0070f76418c0ed560bf96989f72dd1eef46fd3bc	Jan 19 2017, 6:08 PM	★	★

API dox: Add @class comment with CamelCase include, image title without KDEClosedPublicActions

Details

Diff Detail

Revision ContentsChangeset List

Diff 10361

src/kacceleratormanager.h

src/kactionmenu.h

src/kactionselector.h

src/kanimatedbutton.h

src/kassistantdialog.h

src/kcapacitybar.h

src/kcharselect.h

src/kcollapsiblegroupbox.h

src/kcolorbutton.h

src/kcolorcombo.h

src/kcolumnresizer.h

src/kcursor.h

src/kdatecombobox.h

src/kdatepicker.h

src/kdatetimeedit.h

src/kdragwidgetdecorator.h

src/kdualaction.h

src/keditlistwidget.h

src/kfontaction.h

src/kfontchooser.h

src/kfontrequester.h

src/kfontsizeaction.h

src/kguiitem.h

src/kled.h

src/kmessagebox.h

src/kmessagewidget.h

src/kmimetypechooser.h

src/kmultitabbar.h

src/knewpassworddialog.h

src/knewpasswordwidget.h

src/kpagedialog.h

src/kpagemodel.h

src/kpageview.h

src/kpagewidget.h

src/kpagewidgetmodel.h

src/kpassworddialog.h

src/kpixmapregionselectordialog.h

src/kpixmapregionselectorwidget.h

src/kpopupframe.h

src/kratingpainter.h

src/kratingwidget.h

src/kruler.h

src/kselectaction.h

src/kselector.h

src/kseparator.h

src/ksplittercollapserbutton.h

src/ksqueezedtextlabel.h

src/ktimecombobox.h

src/ktitlewidget.h

src/ktoggleaction.h

src/ktogglefullscreenaction.h

src/ktoolbarlabelaction.h

src/ktoolbarpopupaction.h

src/ktoolbarspaceraction.h

src/ktooltipwidget.h

src/kurllabel.h

src/kviewstateserializer.h

src/kxyselector.h

src/lineediturldropeventfilter.h

API dox: Add @class comment with CamelCase include, image title without KDE
ClosedPublic
Actions

Revision Contents
Changeset List