org.apidesign.javadoc.codesnippet.Doclet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of codesnippet-doclet Show documentation
There is a newer version: 1.0
/**
 * Codesnippet Javadoc Doclet
 * Copyright (C) 2015-2016 Jaroslav Tulach 
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, version 3.0 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. Look for COPYING file in the top folder.
 * If not, see http://opensource.org/licenses/GPL-3.0.
 */
package org.apidesign.javadoc.codesnippet;

import com.sun.javadoc.ClassDoc;
import com.sun.javadoc.ConstructorDoc;
import com.sun.javadoc.DocErrorReporter;
import com.sun.javadoc.FieldDoc;
import com.sun.javadoc.LanguageVersion;
import com.sun.javadoc.MethodDoc;
import com.sun.javadoc.RootDoc;
import com.sun.tools.doclets.formats.html.HtmlDoclet;
import java.io.File;

public final class Doclet {
    private static Snippets snippets;
    private Doclet() {
    }
    public static boolean start(RootDoc root) {
        for (ClassDoc clazz : root.classes()) {
            snippets.fixCodesnippets(clazz);
            for (MethodDoc method : clazz.methods()) {
                snippets.fixCodesnippets(method);
            }
            for (FieldDoc field : clazz.fields()) {
                snippets.fixCodesnippets(field);
            }
            for (ConstructorDoc con : clazz.constructors()) {
                snippets.fixCodesnippets(con);
            }
        }
        return HtmlDoclet.start(root);
    }

    public static int optionLength(String option) {
        if (option.equals("-snippetpath")) {
            return 2;
        }
        if (option.equals("-snippetclasses")) {
            return 2;
        }
        if (option.equals("-maxLineLength")) {
            return 2;
        }
        return HtmlDoclet.optionLength(option);
    }

    public static boolean validOptions(String[][] options, DocErrorReporter reporter) {
        snippets = new Snippets(reporter);
        for (String[] optionAndParams : options) {
            Boolean visible = null;
            if (optionAndParams[0].equals("-sourcepath")) {
                visible = true;
            }
            if (optionAndParams[0].equals("-snippetpath")) {
                visible = false;
            }
            if (visible != null) {
                for (int i = 1; i < optionAndParams.length; i++) {
                    for (String elem : optionAndParams[i].split(File.pathSeparator)) {
                        snippets.addPath(new File(elem).toPath(), visible);
                    }
                }
            }
            if (optionAndParams[0].equals("-snippetclasses")) {
                for (int i = 1; i < optionAndParams.length; i++) {
                    snippets.addClasses(optionAndParams[i]);
                }
            }
            if (optionAndParams[0].equals("-maxLineLength")) {
                if ( optionAndParams.length > 1 ) {
                    snippets.setMaxLineLength( optionAndParams[1] );
                }
            }
        }
        return HtmlDoclet.validOptions(options, reporter);
    }

    public static LanguageVersion languageVersion() {
        return HtmlDoclet.languageVersion();
    }
}