Page MenuHomePhabricator

eina: Specify error returns in @return for eina_list API docs
ClosedPublic

Authored by bryceharrington on Mar 6 2018, 1:36 PM.

Details

Summary

For all routines that can return NULL on error, mention this in the
function's @return docs. In cases where a small number of situations
result in this return, move the docs to the @return; in other cases just
state the NULL return briefly and leave the elaboration in the body.

Diff Detail

Repository
rEFL core/efl
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
bryceharrington requested review of this revision.Mar 6 2018, 1:36 PM
bryceharrington created this revision.
cedric accepted this revision.Mar 6 2018, 4:57 PM
This revision is now accepted and ready to land.Mar 6 2018, 4:57 PM
Closed by commit rEFLe849e64fb901: eina: specify error returns in @return for eina_list API docs (authored by bryceharrington, committed by Cedric Bail <cedric@osg.samsung.com>). · Explain WhyMar 6 2018, 7:06 PM
This revision was automatically updated to reflect the committed changes.