package uk.co.badgersinfoil.asxsd;

 import java.util.Iterator;

 import java.util.List;

 import org.eclipse.xsd.XSDAnnotation;

 import org.w3c.dom.Element;

 import uk.co.badgersinfoil.metaas.dom.Documentable;

 public class DocUtils {

         /**

          * 

          * @param anno if null, this function does nothing

          * @param element the API element who's documentation is to be set

          */

         public static void assignDescriptionFromAnnotation(XSDAnnotation anno, Documentable element) {

                 if (anno != null) {

                         String doc = findDocumentation(anno);

                         if (doc != null) {

                                 element.setDescription(doc);

                         }

                 }

         }

         /**

          * attempt to extract simple text from the documentation element of the

          * given annotation.

          */

         public static String findDocumentation(XSDAnnotation annotation) {

                 if (annotation != null) {

                         List docs = annotation.getUserInformation();

                         for (Iterator i = docs.iterator(); i.hasNext(); ) {

                                 // maybe we can do better..?

                                 Element doc = (Element)i.next();

                                 return preProcessComment(doc.getTextContent());

                         }

                 }

                 return null;

         }

         /**

          * Strip initial whitespace from all lines in the given string, and

          * return a string which starts each line with a single space character,

          * ready to go into a javadoc comment.

          */

         private static String preProcessComment(String text) {

                 return text.replaceFirst("\\A\\s*", " ").replaceAll("([\n\r])\\s+", "$1 ");

         }

 }