poi-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bugzi...@apache.org
Subject [Bug 54871] New: XSSFExcelExtractor: Misleading javadoc
Date Fri, 19 Apr 2013 22:35:10 GMT

            Bug ID: 54871
           Summary: XSSFExcelExtractor: Misleading javadoc
           Product: POI
           Version: 3.9
          Hardware: PC
                OS: Linux
            Status: NEW
          Severity: normal
          Priority: P2
         Component: XSSF
          Assignee: dev@poi.apache.org
          Reporter: philip.persad@gmail.com
    Classification: Unclassified

Created attachment 30216
  --> https://issues.apache.org/bugzilla/attachment.cgi?id=30216&action=edit
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.

You are receiving this mail because:
You are the assignee for the bug.

To unsubscribe, e-mail: dev-unsubscribe@poi.apache.org
For additional commands, e-mail: dev-help@poi.apache.org

View raw message