Comments (20)
migrated from Trac, where originally posted by yegor256 on 16-Oct-2011 3:34pm
All src/main/java
and src/test/java
classes should be validated. Javadoc warnings or errors should lead to a broken build.
The budget is 2 hours (including unit test and integration test). If the budget is not enough you can use PDD concept to break the task to smaller ones.
from qulice.
migrated from Trac, where originally posted by yegor256 on 16-Oct-2011 7:13pm
Ivan, this task is for you. The task is a little tricky, since it may be implemented in a few different ways. Please, discuss before implementing.
Keep in mind that we work in branches only: [http://www.tpc2.com/dev/branches]
from qulice.
migrated from Trac, where originally posted by yegor256 on 16-Oct-2011 7:24pm
wait until #15 is closed
from qulice.
migrated from Trac, where originally posted by yegor256 on 17-Oct-2011 3:11pm
You can go ahead, I finished refactoring in #15
from qulice.
migrated from Trac, where originally posted by kotelkin.ivan on 17-Oct-2011 6:03pm
There is comment in #15, that checkstyle tool is migrated to own module qulice-checkstyle.
Could you please clarify the following questions:
- just to double-check: should i extend the functionality of JavadocTagsCheck check?
- As I see, you are trying to extend checkstyle abilities of checking javadocs. So, could you please provide the examples what javadocs do treat invalid. Cause default checkstyle functionality provides strict enough validation of javadocs.
from qulice.
migrated from Trac, where originally posted by yegor256 on 17-Oct-2011 6:08pm
I think that we should create a new module qulice-javadoc
, which will run full-cycle javadoc validation of the project code, and catch all reported warnings/errors from Javadoc tool.
Checkstyle is a good tool, but it can only check formatting. It doesn't check more deeper problems, like @see #method()
broken links, for example. Or any kind of incorrect javadoc tags.
Somehow we should make sure that the project complies with Requirements for Writing Java API Specifications. Checkstyle is not a big help here..
from qulice.
migrated from Trac, where originally posted by kotelkin.ivan on 18-Oct-2011 4:54pm
we should create a new module
So, what will be the entry point to the module code execution? I mean will it be a standalone command-line tool? Or maybe a maven plugin?all reported warnings/errors from Javadoc tool
I have analyzed the javadoc tool abilities. Yes, it can validate links consistency. But it cannot report missing javadocs or required params, @author tags and so on. It is very tolerant.
So I suppose we have to combine outputs/results from serveral utils complementing each other. E.g. checkstyle (with yout custom JavadocTagsCheck) and javadoc.
from qulice.
migrated from Trac, where originally posted by yegor256 on 18-Oct-2011 5:51pm
We already validate what we can with CheckstyleValidator
from qulice-checkstyle
. What we should create in this ticket is a new module qulice-javadoc
and one class inside it: JavadocValidator implements com.qulice.spi.Validator
. This class should call javadoc (somehow) and understand its output. If there are some problems - report.
Maybe you know some other more strict tools for javadoc validation?
ps. Don't forget to re-assign the ticket back to me when you need an answer or my attention.
from qulice.
migrated from Trac, where originally posted by kotelkin.ivan on 19-Oct-2011 10:20am
We will try to find some other utility. Cause for now it seems that the only useful feature of standard javadoc tool is validating links consistency.
Extracting output is not a big deal.
from qulice.
migrated from Trac, where originally posted by yegor256 on 19-Oct-2011 4:07pm
What about doxygen? BTW, take a look: http://stackoverflow.com/questions/2580215
from qulice.
migrated from Trac, where originally posted by kotelkin.ivan on 19-Oct-2011 5:07pm
Yeah I've seen that topic. Dont know. Will need time to analyze.
from qulice.
migrated from Trac, where originally posted by yegor256 on 20-Oct-2011 6:08pm
Ivan is no longer in the project.
from qulice.
migrated from Trac, where originally posted by yegor256 on 22-Jan-2012 11:39pm
Milestone PROTOTYPE deleted
from qulice.
migrated from Trac, where originally posted by yegor on 21-Apr-2013 12:03pm
we moved to Github
from qulice.
@davvd valid bug
from qulice.
@davvd valid bug
@krzyk I tagged this as "bug"
from qulice.
@davvd it is postponed
from qulice.
@yegor256 thanks a lot for reporting, 15 mins added to your acc, pmt ID 000-886e25be
from qulice.
@davvd it is postponed
@krzyk sure, thanks, I added "postponed" label to it
from qulice.
@davvd it is postponed
@krzyk all right, we'll find someone else for this task
from qulice.
Related Issues (20)
- IllegalArgumentException leads to execution failure HOT 7
- Java 17 record type not supported HOT 6
- JUnit test class must be final HOT 1
- method parameter must not hide field of the class HOT 1
- this qualifier must be required even inside lambda HOT 1
- How to Choose Google checks instead of Sun Checks (Checkstyle)? HOT 1
- BranchContains.java:44: Avoid branchContains usages in...
- EqualsTree.java:46: Avoid equalsTree usages in checks and... HOT 1
- PmdListener.java:88-89: If was added to avoid failing...
- PmdValidatorTest.java:130-131: Replace not+empty() with...
- Rebuild GitHub Pages HOT 4
- PMD.AvoidAccessToStaticMembersViaThis check works incorrectly HOT 4
- `java.lang.NullPointerException` at `com.qulice.checkstyle.DiamondOperatorCheck.isDiamondOperatorUsed` HOT 3
- check failed: java.util.concurrent.ExecutionException: java.lang.IllegalStateException: Failed to process files for 0.22.1 HOT 1
- add a rule to check that affirm is used for Assertion HOT 9
- diamond operator check gives false positive HOT 3
- PMD UseUnderscoresInNumericLiterals rule gives false positives on non-divisible number into even 3 digit parts HOT 3
- prohibit private constructors if they are not used in the class HOT 2
- ignore binary files automatically HOT 1
- PMD exception in Java source with variables or methods named with unicode characters for Windows workflow HOT 10
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from qulice.