Interface IDoxygen

  • All Known Implementing Classes:
    MainHandler

    public interface IDoxygen
    Root node of the object model.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ICompound compoundById​(java.lang.String id)
      Returns a compound given its unique \a id.
      ICompound compoundByName​(java.lang.String name)
      Returns a compound given its name (including the scope).
      java.util.ListIterator<ICompound> compounds()
      Returns an iterator that can be used to iterate over the list of compounds found in the project.
      ICompound memberById​(java.lang.String id)
      Returns an public interface to a compound containing a member given it the member's id.
      java.util.ListIterator<ICompound> memberByName​(java.lang.String name)
      Returns a list of all compounds containing at least one members with a certain name.
      void readXMLDir​(java.io.File dir)
      Reads an XML directory produced by doxygen and builds up a data structure representing the contents of the XML files in the directory.
      void release()
      Releases the memory for the object hierarchy obtained by createdObjecModelFromXML().
      void setDebugLevel​(int level)
      Sets the debug level.
    • Method Detail

      • compounds

        java.util.ListIterator<ICompound> compounds()
        Returns an iterator that can be used to iterate over the list of compounds found in the project.
      • compoundById

        ICompound compoundById​(java.lang.String id)
        Returns a compound given its unique \a id. If you have a compound id this function is much more efficient than iterating over the compound list. Returns 0 if the id is not valid.
      • compoundByName

        ICompound compoundByName​(java.lang.String name)
        Returns a compound given its name (including the scope). Returns 0 if the name is not found in the project.
      • memberById

        ICompound memberById​(java.lang.String id)
        Returns an public interface to a compound containing a member given it the member's id. Given the ICompound public interface one can use the same id to obtain the IMember public interface.
        Parameters:
        id - The member id.
      • memberByName

        java.util.ListIterator<ICompound> memberByName​(java.lang.String name)
        Returns a list of all compounds containing at least one members with a certain name. Each compound can be asked to return the list of members with that name.
        Parameters:
        name - The name of the member.
      • release

        void release()
        Releases the memory for the object hierarchy obtained by createdObjecModelFromXML(). First release all iterators before calling this function.
      • setDebugLevel

        void setDebugLevel​(int level)
        Sets the debug level. - 0 all debugging messages are disabled (the default). - 1 display important messages only - 2 display any messages.
      • readXMLDir

        void readXMLDir​(java.io.File dir)
                 throws org.xml.sax.SAXException,
                        java.io.IOException
        Reads an XML directory produced by doxygen and builds up a data structure representing the contents of the XML files in the directory.
        Throws:
        org.xml.sax.SAXException
        java.io.IOException