D5003: Update docs to Frameworks API
This revision was automatically updated to reflect the committed changes. Closed by commit R283:91b73de5bfbc: Update docs to Frameworks API (authored by jriddell). CHANGED PRIOR TO COMMIT https://phabricator.kde.org/D5003?vs=12366=12544#toc REPOSITORY R283 KAuth CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D5003?vs=12366=12544 REVISION DETAIL https://phabricator.kde.org/D5003 AFFECTED FILES src/kauthaction.h src/kauthactionreply.h src/kauthexecutejob.h src/kauthhelpersupport.h To: jriddell, leinir Cc: #frameworks
D5003: Update docs to Frameworks API
leinir accepted this revision. leinir added a comment. This revision is now accepted and ready to land. That looks about right to me! :) REPOSITORY R283 KAuth BRANCH docs REVISION DETAIL https://phabricator.kde.org/D5003 To: jriddell, leinir Cc: #frameworks
D5003: Update docs to Frameworks API
jriddell marked an inline comment as done. jriddell added a comment. added some info to kauthexecutejob.h about AuthStatus data() does get the data returned by the action (not direct return I guess) as well as set during the action, updated. INLINE COMMENTS > leinir wrote in kauthexecutejob.h:82 > Returned isn't semantically right, here, though the term "helper" is a bit > ambiguous... What is meant by "sent by the helper" is more to the point "send > by the helper using HelperSupport::progressStep(QVariant)"... which is > somewhat clunky, but explains more properly what is going on here. Return > would suggest that it is only done at the end, whereas this can, > specifically, be done multiple times (basically, every time > progressStep(QVariant) is called). So... perhaps changing this to be > something like > > /** >* Use this to get the data set by HelperSupport::progressStep(QVariant) >* This function is particularly useful once the >* job has completed. During execution, simply >* read the data in the newData signal. >* @see ExecuteJob::newData >* returns the data sent by the helper >*/ it can also be set by the return of the auth action so I mentioned both REPOSITORY R283 KAuth REVISION DETAIL https://phabricator.kde.org/D5003 To: jriddell, leinir Cc: #frameworks
D5003: Update docs to Frameworks API
jriddell updated this revision to Diff 12366. jriddell added a comment. - mention statusChanged REPOSITORY R283 KAuth CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D5003?vs=12365=12366 BRANCH docs REVISION DETAIL https://phabricator.kde.org/D5003 AFFECTED FILES src/kauthaction.h src/kauthactionreply.h src/kauthexecutejob.h src/kauthhelpersupport.h To: jriddell, leinir Cc: #frameworks
D5003: Update docs to Frameworks API
jriddell updated this revision to Diff 12365. jriddell marked an inline comment as done. jriddell added a comment. - better description for kauthexecutejob data REPOSITORY R283 KAuth CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D5003?vs=12359=12365 BRANCH docs REVISION DETAIL https://phabricator.kde.org/D5003 AFFECTED FILES src/kauthaction.h src/kauthactionreply.h src/kauthexecutejob.h src/kauthhelpersupport.h To: jriddell, leinir Cc: #frameworks
D5003: Update docs to Frameworks API
leinir requested changes to this revision. leinir added a comment. This revision now requires changes to proceed. Thinking this is... well under way, with a couple of details :) INLINE COMMENTS > kauthactionreply.h:338 > -* > -* In case of errors coming from the library, the type() is > -* ActionReply::KAuthError. In this case, errorCode() will always be one of > the Thinking it would be kind of good to translate this into something more useful for the Action::AuthStatus enum documentation... Just removing it entirely seems to me to get rid of the verbose "don't use this for your own errors, this is for authentication only, you should look over here" thing which is inherent in the current text... Perhaps simply adding @see ExecuteJob::newData to that enum's documentation might do the trick? > kauthexecutejob.h:82 > /** > - * @returns the data sent by the helper > + * @returns the data returned by the helper > */ Returned isn't semantically right, here, though the term "helper" is a bit ambiguous... What is meant by "sent by the helper" is more to the point "send by the helper using HelperSupport::progressStep(QVariant)"... which is somewhat clunky, but explains more properly what is going on here. Return would suggest that it is only done at the end, whereas this can, specifically, be done multiple times (basically, every time progressStep(QVariant) is called). So... perhaps changing this to be something like /** * Use this to get the data set by HelperSupport::progressStep(QVariant) * This function is particularly useful once the * job has completed. During execution, simply * read the data in the newData signal. * @see ExecuteJob::newData * returns the data sent by the helper */ REPOSITORY R283 KAuth REVISION DETAIL https://phabricator.kde.org/D5003 To: jriddell, leinir Cc: #frameworks
D5003: Update docs to Frameworks API
jriddell created this revision. Restricted Application added a project: Frameworks. Restricted Application added a subscriber: Frameworks. REVISION SUMMARY Update API docs TEST PLAN Read them REPOSITORY R283 KAuth BRANCH docs REVISION DETAIL https://phabricator.kde.org/D5003 AFFECTED FILES src/kauthaction.h src/kauthactionreply.h src/kauthexecutejob.h src/kauthhelpersupport.h To: jriddell, leinir Cc: #frameworks
