How to work around the stricter Java 8 Javadoc when using Maven -

-

you'll realize jdk8 lot more strict (by default) when comes javadoc. (link - see last bullet point)

if never generate javadoc of course you'll not experience problems things maven release process , possibly ci builds fail worked fine jdk7. checks exit value of javadoc tool fail. jdk8 javadoc more verbose in terms of warnings compared jdk7 that's not scope here. talking errors!

this question exist collect proposals on it. best approach ? should these errors fixed once , in source code files? if have huge code base might lot of work. other options exist ?

you welcome comment stories of fails pass.

horror stories of fails

wsimport tools

wsimport tool code generator creating web service consumers. included in jdk. if use wsimport tool jdk8 nevertheless produce source code that cannot compiled javadoc compiler jdk8.

@author tag

i'm opening source code files 3-4 years old , see this:

/**  * best class  * @author john <john.doe@mine.com>   */

this fails because of < character. strictly speaking justified, not forgiving.

html tables

html tables in javadoc? consider valid html:

/**  *  * <table>  *   <tr>  *      <td>col1</td><td>col2</td><td>col3</td>  *   </tr>  * </table>  */

this fails error message no summary or caption table. 1 quick fix this:

/**  *  * <table summary="">  *   <tr>  *      <td>col1</td><td>col2</td><td>col3</td>  *   </tr>  * </table>  */

but why has stop-the-world error javadoc tool beats me??

things fail more obvious reasons

  1. invalid links, e.g. {@link notexist}
  2. malformed html, e.g. always returns <code>true<code> if ...

update

links:

excellent blog on subject stephen colebourne.

for now, easiest way know work around stricter java 8 javadoc when using maven deactivating it.

since parameter -xdoclint:none exists in java 8, defining parameter breaks build other java. prevent this, can create profile active java 8, making sure our solution works regardless of java version.

<profiles>     <profile>         <id>disable-java8-doclint</id>         <activation>             <jdk>[1.8,)</jdk>         </activation>         <properties>             <additionalparam>-xdoclint:none</additionalparam>         </properties>     </profile> </profiles>

just add pom , you're go.


Comments

Post a Comment

Popular posts from this blog

java - WrongTypeOfReturnValue exception thrown when unit testing using mockito -

-
my test list<person> mylist; @test public void testisvalidperson() { mylist = new arraylist<person>(); mylist.add(new person("tom")); when(persondao.get(person)).thenreturn(mylist); when((persondao.get(person)).isempty()).thenreturn(false);//------exception thrown boolean result = service.isvalid("tom"); assertfalse(result); } method tested: public boolean isvalid(string person){ persondao = new persondao(); person personobj = new person(person); return (persondao.get(person).isempty())?false : true; } exception thrown: org.mockito.exceptions.misusing.wrongtypeofreturnvalue: boolean cannot returned get() get() should return list *** if you're unsure why you're getting above error read on. due nature of syntax above problem might occur because: 1. exception *might* occur in wrongly written multi-threaded tests. please refer mockito faq on limitations of concurrency testing. 2. sp
Read more

php - Magento - Deleted Base url key -

-
i working on cleaning url: http://mydomain.com/shop/shop/deals i going through settings in configuration tab in admin panel on magento , change secure , unsecure base urls remove first base url "shop" web page read: http://mydomain.com/shop/deals so changed unsecure base urls mydomain.com/shop mydomain.com , secure 12.345.67.89/shop 12.345.67.89. wrong thing do. i cannot reload page or admin console. how access these files through ftp , change correctly there?? when make changes in admin panel changes made in database not in file. have make changes in database. 1.go database , select core_config_data table under table find web/unsecure/base_url , web/secure/base_url . make changes here. don't forget clear cache in var/cache folder
Read more

android - How to disable Button if EditText is empty ? -

-
i have edittext , button in application. when button clicked,the text entered in edittext added listview. i want disable button if edittext empty.how ? this code button click imagebutton imb=(imagebutton)findviewbyid(r.id.btn_send); imb.setonclicklistener(new onclicklistener() { @override public void onclick(view arg0) { edittext et = (edittext)findviewbyid(r.id.edittext1); string str = et.gettext().tostring(); web1.add(str); toast.maketext(shoutsingleprogram.this, "you entered...."+str, toast.length_short).show(); adapter1.notifydatasetchanged(); et.settext(""); } }); } how can ? edittext1.addtextchangedlistener(new textwatcher() { @override public void ontextchanged(charsequence s, int start, int before, in
Read more