com.manoelcampos.javadoc.coverage.stats.JavaDocsStats Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javadoc-coverage Show documentation
Doclet to generate coverage reports of JavaDoc documentation.
There is a newer version: 1.1.1
/*
 * Copyright 2017-2017 Manoel Campos da Silva Filho
 *
 * Licensed under the General Public License Version 3 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    https://www.gnu.org/licenses/gpl-3.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.manoelcampos.javadoc.coverage.stats;

import com.manoelcampos.javadoc.coverage.Utils;
import com.sun.javadoc.ClassDoc;
import com.sun.javadoc.RootDoc;

/**
 * Computes JavaDoc coverage statistics for Java files received by the JavaDoc tool.
 *
 * It's the main class to store JavaDocs statistics for any kind of
 * documentable element into a Java source file.
 * It includes the computed statistics for an entire Java project
 * parsed by the JavaDoc Tool.
 *
 * @author Manoel Campos da Silva Filho
 * @since 1.0.0
 */
public class JavaDocsStats implements DocStats {
    /**
     * Stores the root of the program structure information.
     */
    private final RootDoc rootDoc;

    private final PackagesDocStats packagesDocStats;
    private final ClassesDocStats classesDocStats;

    /**
     * Instantiates an object to compute JavaDoc coverage statistics for all Java files
     * received by the JavaDoc tool.
     *
     * @param rootDoc root element which enables reading JavaDoc documentation
     */
    public JavaDocsStats(final RootDoc rootDoc) {
        this.rootDoc = rootDoc;
        this.classesDocStats = new ClassesDocStats(rootDoc.classes());
        this.packagesDocStats = computePackagesDocsStats();
    }

    /**
     * Computes JavaDoc coverage statistics for detected packages.
     *
     * @return packages' JavaDoc coverage statistics
     */
    private PackagesDocStats computePackagesDocsStats() {
        final PackagesDocStats stats = new PackagesDocStats();
        for (final ClassDoc doc : rootDoc.classes()) {
            stats.addPackageDoc(doc.containingPackage());
        }

        return stats;
    }

    /**
     * Gets the object containing JavaDoc coverage statistics for detected packages.
     *
     * @return packages' JavaDoc coverage statistics
     * @see #computePackagesDocsStats()
     */
    public PackagesDocStats getPackagesDocStats() {
        return packagesDocStats;
    }

    /**
     * Gets the object containing JavaDoc coverage statistics for detected classes.
     *
     * @return classes' JavaDoc coverage statistics
     */
    public ClassesDocStats getClassesDocStats() { return classesDocStats; }

    @Override
    public String getType() {
        return "Project JavaDoc Statistics";
    }

    @Override
    public long getDocumentedMembers() {
        return packagesDocStats.getDocumentedMembers() + classesDocStats.getDocumentedMembers();
    }

    @Override
    public double getDocumentedMembersPercent() {
        return Utils.mean(packagesDocStats.getDocumentedMembersPercent(), classesDocStats.getDocumentedMembersPercent());
    }

    @Override
    public long getMembersNumber() {
        return classesDocStats.getMembersNumber() + packagesDocStats.getMembersNumber();
    }
}