Hello team, 
     
    As commented in the related bugzilla, I think that the OCL Help
    doesn't work because the javadoc (API Reference help's topic) is not
    created inside the own org.eclipse.ocl.doc plugin. The previous
    cbi-athena process managed to invoke the proper stuff to create
    javadoc from the compiled classes jars so that the javadoc wwas
    included inside the doc plugin before signing and packing. Our
    current build system doesn't do anything related to javadoc.
    Actually, I would have to investigate how easy/diffucult could be
    interfering the compile-jar-sign-package process which is currently
    done by buckminster. 
     
    I've been looking at what other modeling projects do: 
     
    - EMF doesn't create any javadoc so that there is not any API
    Reference topic inside the Help. 
    - Acceleo doesn't create any javadoc so that there is not any  API
    Reference topic insidethe Help. 
    - Xtext separately create javadoc from the build so that they create
    Javadoc but they don't include into the doc plugin, hence,  there is
    not any API Reference topic inside the Help. 
     
    I'm not sure if not including the javadoc into the help's content
    come from other projects releng's ignorance and/or laziness,
    buckminster's limitation, or any other applied rule/policy. 
     
    Kenn do you have any extra information which could be useful to make
    some progress on this. 
     
    In any case, I feel that we need to at least do what Xtext does 
     
    Cheers, 
    Adolfo. 
     
    El 15/02/2011 11:26, Adolfo Sánchez-Barbudo Herrera escribió:
    
      
      Team, 
       
      Bad news. In my Indigo M5 installation I can see the
      org.eclipse.ocl.doc plugin but if I do Help -> Help Contents I
      can't see our OCL Developer Guide :\...  
       
      ... Creating a bugzilla 
       
      Regards, 
      Adolfo. 
      El 15/02/2011 11:20, Adolfo Sánchez-Barbudo Herrera escribió:
      
        
        Axel, 
         
        I agree with you. Now you mention that, I'm not really aware of
        how the documentation is managed during the building process...
        It would be good to start looking into this. 
         
        P.S: If you have any knowledge concercing this, please let me
        know it. 
         
        Cheers, 
        Adolfo. 
         
        El 15/02/2011 11:12, Axel Uhl escribió:
        Hi,  
           
          org.eclipse.ocl.doc contributes Javadoc for the reference
          documentation. Wouldn't it be useful to also add the Javadoc
          for the examples bundles that are---although an
          unofficial---sort of an API? IMHO, this would make sense for
          the Pivot stuff as well as for event manager and impact
          analyzer. What do you think?  
           
          Best,  
          -- Axel  
          _______________________________________________  
          mdt-ocl.dev mailing list  
          mdt-ocl.dev@xxxxxxxxxxx
           
          https://dev.eclipse.org/mailman/listinfo/mdt-ocl.dev
           
           
         
         
        
       
       
      
     
     
    
  
 |