Le 02/07/15 11:36, Zheng, Kai a écrit :
> Thanks Emmanuel again for sorting this out. Some lazy guys like me should
> definitely be more careful and keep the mentioned points in mind before
> commit. Some notes here.
>
>>> The README.md file has none.
> I don't know if github markdown supports comment or not. Need to see if
> doable for the READMEs.
It does :
Title: Table widget
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
.
http://www.apache.org/licenses/LICENSE-2.0
.
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
But please feel free to doublecheck.
> About Javadoc, I'm wondering if we would allow some exceptions for test
> codes, because from my point of view, we could make the class names and
> methods good long enough readable and understandable.
Absolutely right. Test code does not need the level of Javadoc we use
for real code, especially for methods. I usually just add a Class
header, and a method header which just tells what is the method testing.
Nothing fancy.
>
>>> To be more spot on : it's absolutely critical to add Javadoc in Interfaces
>>> : this is what get exposed to the public.
> Sure! Absolutely. I'm going to add missing ones for the existing APIs.
>
> About coding styles, I agree totally. Need to fix the found issues
> immediately. Sometime it would be great to have checking styles to be
> enforced so such exceptions can be found soon once they get in.
We have a Jenkins server that build Kerby every day, and it provides a
good set of rules violation :
https://analysis.apache.org/dashboard/index/212397
