Review Request 128530: Improve API documentation
Alexander Zhigalin
alexander at zhigalin.tk
Thu Nov 3 08:53:29 UTC 2016
> On Июль 26, 2016, 8:24 п.п., Sven Brauch wrote:
> > shell/sessioncontroller.h, line 88
> > <https://git.reviewboard.kde.org/r/128530/diff/1/?file=472453#file472453line88>
> >
> > Why have this parameter if the function is not called anywhere like that?
>
> Alexander Zhigalin wrote:
> Because this function is an alias of the session locker function from shell/sessionlock.h which have this parameter
>
> Sven Brauch wrote:
> Yeah but apparently nobody uses it, right?
> Don't care though, if you see a reason to have it, it doesn't matter to me.
>
> Nicolás Alvarez wrote:
> This broke binary compatibility!
>
> Sven Brauch wrote:
> That's why this kind of patch never should go into stable branches.
>
> Alexander Zhigalin wrote:
> What is happened?
>
> Nicolás Alvarez wrote:
> This change replaced tryLockSession(const QString&) with tryLockSession(const QString&, bool). It was committed to the 5.0 branch (which is supposed to stay binary-compatible), and we didn't notice until now. KDevelop 5.0.1 (or newer) won't start with KDevPlatformShell 5.0.0 (or older) and viceversa because of this changed symbol.
>
> Alexander Zhigalin wrote:
> This patch was intended for master.
> Summoning @kfunk
> BTW, why you should use different versions of kdevplatform and kdevelop?
>
> Kevin Funk wrote:
> I've overlooked the change in `SessionController::tryLockSession`. This of shouldn't have made it into 5.0. Sorry.
>
> @nalvarez: How did you notice?
> @scummos: I still think patches like this make sense to go into the stable branches (well, as long as they don't affect API/ABI stability...).
>
> @Alexander: Please don't mix documentation fixes with actual code changes like this next time. Not your fault, though, I just overlooekd it.
> @Alexander: Please don't mix documentation fixes with actual code changes like this next time. Not your fault, though, I just overlooekd it.
Sorry.
I firstly thought this patch as a general one, not only documentation, but I have ended changing almost only the documentation...
- Alexander
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/128530/#review97855
-----------------------------------------------------------
On Авг. 25, 2016, 10:22 п.п., Alexander Zhigalin wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/128530/
> -----------------------------------------------------------
>
> (Updated Авг. 25, 2016, 10:22 п.п.)
>
>
> Review request for KDevelop.
>
>
> Repository: kdevplatform
>
>
> Description
> -------
>
> Improved documentation by fixing all the -Wdocumentation warnings which could be fixed ATM (almost all).
>
>
> Diffs
> -----
>
> interfaces/ibuddydocumentfinder.h 59ef367fbbf78693b211b8ecc66d9a9d9bbf5ba4
> interfaces/idocumentcontroller.h a66fe9c91b95590a7996eb365bfe1589c24b320f
> interfaces/iplugin.h 1e09f12c795b8944cfe063c261e8b5cf198d772f
> interfaces/iproblem.h a3f2b93f270c4dec76a1f1d9a319bba42f7935ba
> interfaces/iuicontroller.h fe7d07ff0377361b1e950cc50ab0c65f2711566c
> interfaces/launchconfigurationpage.h 73b810695161faf61cccbb5cc9270f135c43457a
> interfaces/launchconfigurationtype.h e1efbf38b46fa4456ccc3f3b4e9d918dd3b6074f
> language/backgroundparser/backgroundparser.h 8546913621a28978d01135e1c0610eea5602fcf9
> language/codecompletion/codecompletionitem.h 1d83e438b3b96e359d12bfb30a357860e2faa7dc
> language/codegen/applychangeswidget.h 3a9122373766d828e1a398f3ce8e3051d5795adf
> language/codegen/codegenerator.h 8e1b1e03f5201eaef885bcf1fdd83bda2cde388a
> language/codegen/codegenerator.cpp e399965d701739959b4cd45d7f1ce8af036bdd5e
> language/codegen/templaterenderer.h ed5bdba0da74177c021c6a5818f8fc629976c626
> language/codegen/utilities.h 00f9e62d19abebbbcddb51725e4f377f1443e7da
> language/duchain/aliasdeclaration.h ea201ac6f112239d32b7957621b2ac4cb8dc33b7
> language/duchain/builders/abstractcontextbuilder.h 6c77d86cb275ed0d1b852f0d21349b554e651759
> language/duchain/builders/abstractdeclarationbuilder.h 45040b46d1cebeb15dfedc5839c1bf5682a31129
> language/duchain/builders/abstractusebuilder.h 36367027949ca0fa38d426c929ccbf1c650ce008
> language/duchain/declaration.h 27270bdb7c76903ea4e40711340143a67562265e
> language/duchain/declarationid.h 775c3cf86066b2df77059ee8bcfcf01ba97a5a57
> language/duchain/definitions.h fdf882f42b2b23b1dacdb212ca059f998c841fb5
> language/duchain/duchain.h 56162d4ef416b0dcb0d9d1197445f7ff571372d4
> language/duchain/duchainbase.h c7cae377df9ea4d488dab63ebba367beb75c1b5f
> language/duchain/duchainregister.h 8b3dfa741074cf4a56a3660de95877d79ce6a78f
> language/duchain/duchainutils.h 1f550b752811d7e9f12a54f69cdfdf817b41fc1a
> language/duchain/ducontext.h 2475132b5f606e42e8263debddb68d186fc69861
> language/duchain/dumpdotgraph.h 85ac59d2ee82acd023e2e13ea43d8d7067daf1d7
> language/duchain/forwarddeclaration.h 7b103d7d7a19475066326ad19d6d37adefad9a78
> language/duchain/navigation/abstractincludenavigationcontext.h ac6e59dae3618f348b43238e91c3967d00341500
> language/duchain/navigation/abstractnavigationcontext.h 1f924505ad9056324f2d0fa936ab041f22ed2459
> language/duchain/persistentsymboltable.h 3c6cfddf6b51d1239ca0b7b11a3dd2929e216ada
> language/duchain/topducontext.h 2e50164724947c8ffaaf1269a5a9063f50a97268
> language/duchain/topducontextdynamicdata.h fd7cbc1aedbdc83351966b64e369e561449e5296
> language/interfaces/ilanguagesupport.h 9ac7f369067be3eec84e5016e54018359705c0da
> language/interfaces/iquickopen.h 855a8ec9a48b5d7433bb7256a66b6ff68402164f
> outputview/ioutputview.h 6e937f8d70cf21c1cef8ff73824aada4c0922b76
> plugins/contextbrowser/browsemanager.h 2ccf313126ba74a3303949b1624875bd6a38fc94
> plugins/externalscript/externalscriptplugin.h 645a9c8b64edb325a62043ce48918f7a05db3512
> plugins/filetemplates/templateoptionspage.h 898e1b88ca9b47c04a5654a5a724f10f42f4026c
> plugins/grepview/grepviewplugin.h 61ae56a491f1bdfa8dfb4afcbe6b7fb5395c08ad
> plugins/grepview/grepviewplugin.cpp ff84cdd2f10685bfffebc6a74c5da36d0f08c00f
> plugins/projectmanagerview/projectmodelitemdelegate.cpp 84a923e9f1e270dcc22a2f2831a96e4c49857420
> project/interfaces/iprojectfilemanager.h 256c0b2a9d6479e9dc64e03229f3f891d2a693ed
> serialization/itemrepository.h 821046705f296522a631d2f436e9ed1b4d1f0488
> serialization/referencecounting.h 78b4321641b75be1eb60e39c7fc2561e161b4746
> shell/documentcontroller.h b28c129a7292a179d3f710cd51486eea64dd5aed
> shell/launchconfiguration.h 8d80a0f6707bbb390c577538506e9b45a0840c04
> shell/launchconfigurationdialog.ui 51e4ae27c5c61d80b2299a698d54d1e742947d97
> shell/plugincontroller.h d5900a3f45317cbb75544e30e3f754fee7c6058d
> shell/progresswidget/progressmanager.h 440e35f5fe954086b5b59cf19ff7d6afccd03f9f
> shell/sessioncontroller.h f358540fa53c9d42b67d487d756c95cb82728570
> shell/sessioncontroller.cpp 2c5d6eac5d8cfa87cf359d98af0d1376886d13cd
> sublime/document.h 2e0001373b4cbe6d27d39730876283eed372e3a3
> tests/testfile.h ddf49f45985ecfe429e5bd95f3f69cbf9c517dc2
> util/convenientfreelist.h 91eafe74cd4a359c29e42c8b0e3c26440b01418f
> util/embeddedfreetree.h b6df986fd6558e972e619e4eb5d3c4d3017bc04d
> util/formattinghelpers.h 04a6bab5204ada823e4f4676fca06fd3056e8eb7
> util/pushvalue.h 41434bf31b1ac65ab82c30fddb93cdc1414f954c
> vcs/vcsannotation.h 3a22e921648457cffe35837ea8cc66536718bb88
> vcs/vcsannotation.cpp 7b94a91d1bdcec6d67e55c21b9e7c1dbc63b218f
> vcs/vcslocation.h 6a3c5431ac2664c97924a86bda9e5d5b2a20c77d
> vcs/vcslocation.cpp b1f9252b10dcb583094cb0a424eba1dbb83329c6
> vcs/vcsstatusinfo.h d0e8736cf6077a383e5f47e77e1419bf4eb9c2ea
>
> Diff: https://git.reviewboard.kde.org/r/128530/diff/
>
>
> Testing
> -------
>
>
> Thanks,
>
> Alexander Zhigalin
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kdevelop-devel/attachments/20161103/a6882937/attachment.html>
More information about the KDevelop-devel
mailing list