net.thevpc.commons.md.doc.java.JPDoc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of thevpc-common-md-doc Show documentation
Javadoc distiller to Markdown Library
There is a newer version: 1.2.0
/**
 * ====================================================================
 *            Nuts : Network Updatable Things Service
 *                  (universal package manager)
 * 

 * is a new Open Source Package Manager to help install packages
 * and libraries for runtime execution. Nuts is the ultimate companion for
 * maven (and other build managers) as it helps installing all package
 * dependencies at runtime. Nuts is not tied to java and is a good choice
 * to share shell scripts and other 'things' . Its based on an extensible
 * architecture to help supporting a large range of sub managers / repositories.
 * 

 *
 * Copyright [2020] [thevpc]
 * Licensed 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 net.thevpc.commons.md.doc.java;

import net.thevpc.commons.md.MdElement;
import net.thevpc.commons.md.doc.util.DocReader;
import com.github.javaparser.javadoc.Javadoc;
import com.github.javaparser.javadoc.JavadocBlockTag;
import com.github.javaparser.javadoc.description.JavadocDescriptionElement;
import net.thevpc.commons.md.doc.JDDoc;

/**
 *
 * @author vpc
 */
public class JPDoc implements JDDoc {

    Javadoc jd;

    public JPDoc(Javadoc jd) {
        this.jd = jd;
    }

    @Override
    public String getTag(String tag) {
        for (JavadocBlockTag blockTag : jd.getBlockTags()) {
            if (blockTag.getTagName().equals(tag)) {
                return blockTag.getContent().toText().trim();
            }
        }
        return null;
    }

    @Override
    public MdElement getDescription() {
        if (jd.getDescription() == null) {
            return null;
        }
        DocReader dr = new DocReader();
        for (JavadocDescriptionElement element : jd.getDescription().getElements()) {
            dr.add(element);
        }
        return dr.parse();
//        return new JPDocElementList(jd.getDescription().getElements().stream().map(x -> _JDDocElement(x))
//                .toArray(JDDocElement[]::new));
    }

//    private static JDDocElement _JDDocElement(JavadocDescriptionElement e) {
//        if (e instanceof JavadocSnippet) {
//            return _JDDocElement(e.toText());
//        }
//        if (e instanceof JavadocInlineTag) {
//            return new JPDocElementTag((JavadocInlineTag) e);
//        }
//        throw new IllegalArgumentException("Unsupported " + e);
//    }
//    public static JDDocElement _JDDocElement(String str) {
//        List all = new ArrayList();
//        CharReader in = new CharReader(str);
//        while (!in.isEmpty()) {
//            JDDocElement a = readAny(in);
//            if (a == null) {
//                System.err.println("Unable to read");
//                break;
//            } else {
//                all.add(a);
//            }
//        }
//        if (all.size() == 0) {
//            return new JPDocElementString("");
//        }
//        if (all.size() == 1) {
//            return all.get(0);
//        }
//        return new JPDocElementList(all.toArray(new JDDocElement[0]));
//    }



//    private static String readHtmlTagEnd(StringBuilder in, String name) {
//        StringBuilder sb = new StringBuilder();
//        int y = name.length() + 3;
//        String end = "";
//        while (in.length() > y) {
//            if (in.substring(0, y).equals(end)) {
//                in.delete(0, y);
//                return sb.toString();
//            }
//            sb.append(in.charAt(0));
//            in.delete(0, 1);
//        }
//        while (in.length() > 0) {
//            sb.append(in.charAt(0));
//            in.delete(0, 1);
//        }
//        return sb.toString();
//    }

    /*
    
    for (String line : c.getRawCommentText().split("\n")) {
            line = line.trim();
            if (line.startsWith("%category ")) {
                String cat = line.substring("%category ".length()).trim();
                if (cat.length() > 0) {
                    System.out.println("found " + cat);
                    return cat;
                }
            }
        }
        return "Other";
    
     */
}