Bug 54871 - [PATCH] XSSFExcelExtractor: Misleading javadoc
Summary: [PATCH] XSSFExcelExtractor: Misleading javadoc
Alias: None
Product: POI
Classification: Unclassified
Component: XSSF (show other bugs)
Version: 3.9-FINAL
Hardware: PC Linux
: P2 normal (vote)
Target Milestone: ---
Assignee: POI Developers List
Depends on:
Reported: 2013-04-19 22:35 UTC by Phil Persad
Modified: 2013-06-25 15:05 UTC (History)
1 user (show)

Patch to fix the javadoc. (653 bytes, patch)
2013-04-19 22:35 UTC, Phil Persad
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Phil Persad 2013-04-19 22:35:10 UTC
Created attachment 30216 [details]
Patch to fix the javadoc.

The javadoc for XSSFExcelExtractor#setIncludeCellComments states:

"Should cell comments be included? Default is true"

From line 53:

private boolean includeCellComments = false;

Clearly, the default is in fact false.  This could easily cause some poor developer to spend a great deal of time pulling out their hair, saying very unkind things to their monitors, and wondering why on earth the cell comments are not being extracted.

I have attached a patch file to fix the issue.  There was a choice between changing the default behaviour and changing the javadoc to match the default behaviour.  I have opted for the latter as it's less likely to break code which is already working and because it matches the behaviour of the ExcelExtractor.
Comment 1 Nick Burch 2013-06-25 15:05:46 UTC
Thanks, fixed in r1496510, will go live next time the site is published.