cloudstack-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GabrielBrascher <...@git.apache.org>
Subject [GitHub] cloudstack pull request: Add Health Check Command to NSX plugin
Date Thu, 14 Jan 2016 16:31:07 GMT
Github user GabrielBrascher commented on a diff in the pull request:

    https://github.com/apache/cloudstack/pull/1293#discussion_r49748364
  
    --- Diff: plugins/network-elements/nicira-nvp/src/main/java/com/cloud/network/resource/wrapper/NiciraCheckHealthCommandWrapper.java
---
    @@ -0,0 +1,63 @@
    +//
    +// 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.
    +//
    +
    +package com.cloud.network.resource.wrapper;
    +
    +import org.apache.log4j.Logger;
    +
    +import com.cloud.agent.api.Answer;
    +import com.cloud.agent.api.CheckHealthAnswer;
    +import com.cloud.agent.api.CheckHealthCommand;
    +import com.cloud.network.nicira.ControlClusterStatus;
    +import com.cloud.network.nicira.NiciraNvpApi;
    +import com.cloud.network.nicira.NiciraNvpApiException;
    +import com.cloud.network.resource.NiciraNvpResource;
    +import com.cloud.resource.CommandWrapper;
    +import com.cloud.resource.ResourceWrapper;
    +
    --- End diff --
    
    @miguelaferreira When I am debugging, extending or just reading some code it is always
good to find some documentation. I think that if you add a Javadoc block explaining the code
and its purpose, it will help on our maintenance process.
    
    For example, the “NiciraCheckHealthCommandWrapper” name doesn't tell much for me about
the code in a glance. What is a CheckHealth? What is this Nicira component? 
    
    The idea of a documentation is to help people that never saw a class or method to understand
what it does, why it is needed, what can be added or not to its context, exceptions that it
may throw and other useful information. Thus, someone can understand the main idea of a class
or method without diving deep inside of the code.
    
    I believe that the use of Javadoc can make the code friendlier, specially to new developers.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message