The docblocks of some complex functions are pretty light or missing altogether. It would help improve transparency of how the module works if the functions were explained in more detail with explanations of the parameters.

CommentFileSizeAuthor
#5 docblocks-1764450-5-D6.patch4.41 KBpwolanin
#1 docblocks-1764450-1.patch4.36 KBcpliakas

Comments

cpliakas’s picture

cpliakas commented
Status: Active » Needs review
StatusFileSize
new docblocks-1764450-1.patch4.36 KB

The attached patch attacks a few functions in the apachesolr.index.inc file. I am posting early to see if the maintainers are willing to accept dockblocks like this. This is a lot of effort to do, so I don't want to waste time if there isn't a chance of this stuff getting reviewed and integrated into the module.

If there is interest, maybe we can tackle one file at a time?

Thanks!
Chris

nick_vh’s picture

nick_vh
he/him
Location Ghent
commented

are these according to the standard? eg. if I run doxygen on the module code, it will give me proper documentation per function? If so I am 100% ok with it!

cpliakas’s picture

cpliakas commented

Nick_vh,

Yes, the Doxygen and comment formatting conventions documentation has been strictly followed.

Chris

pwolanin’s picture

pwolanin commented
Title: Improve the docblocks » Improve the docblocks in apachesolr.index.inc
Version: 7.x-1.x-dev » 6.x-3.x-dev
Status: Needs review » Patch (to be ported)
pwolanin’s picture

pwolanin commented
Status: Patch (to be ported) » Fixed
StatusFileSize
new docblocks-1764450-5-D6.patch4.41 KB

applied this patch to 6.x

nick_vh’s picture

nick_vh
he/him
Location Ghent
commented
Status: Fixed » Closed (fixed)