Jira (PDOC-156) Support @api tag for classes (in addition to functions)

2018-03-05 Thread Eric Putnam (JIRA)
Title: Message Title


 
 
 
 

 
 
 

 
   
 Eric Putnam commented on  PDOC-156  
 

  
 
 
 
 

 
 
  
 
 
 
 

 
  Re: Support @api tag for classes (in addition to functions)   
 

  
 
 
 
 

 
 Users can now apply the @api tag to classes and defined types and see results in the generated markdown. Not sure about generated HTML.  
 

  
 
 
 
 

 
 
 

 
 
 Add Comment  
 

  
 

  
 
 
 
  
 

  
 
 
 
 

 
 This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)  
 
 

 
   
 

  
 

  
 

   





-- 
You received this message because you are subscribed to the Google Groups "Puppet Bugs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com.
To post to this group, send email to puppet-bugs@googlegroups.com.
Visit this group at https://groups.google.com/group/puppet-bugs.
For more options, visit https://groups.google.com/d/optout.


Jira (PDOC-156) Support @api tag for classes (in addition to functions)

2017-01-11 Thread William Hopper (JIRA)
Title: Message Title
 
 
 
 
 
 
 
 
 
 
  
 
 William Hopper commented on  PDOC-156 
 
 
 
 
 
 
 
 
 
 

 
 
 
 
 
 
 
  Re: Support @api tag for classes (in addition to functions)  
 
 
 
 
 
 
 
 
 
 
I also just discovered that our handling of @api (in HTML) is buggy for functions. It only works for functions with multiple dispatches, and thus overload tags, i.e, this kind of works: 
 
 
 
 
 
 
# Subtracts two things. 
 
 
 
 
Puppet::Functions.create_function(:subtract) do 
 
 
 
 
  # @api private 
 
 
 
 
  dispatch :subtract_ints do 
 
 
 
 
  ... 
 
 
 
 
  end 
 
 
 
 
  
 
 
 
 
  dispatch :subtract_arrays do 
 
 
 
 
  ... 
 
 
 
 
  end 
 
 
 
 
  

Jira (PDOC-156) Support @api tag for classes (in addition to functions)

2017-01-11 Thread Hailee Kenney (JIRA)
Title: Message Title
 
 
 
 
 
 
 
 
 
 
  
 
 Hailee Kenney created an issue 
 
 
 
 
 
 
 
 
 
 

 
 
 
 
 
 
 
 Puppet Strings /  PDOC-156 
 
 
 
  Support @api tag for classes (in addition to functions)  
 
 
 
 
 
 
 
 
 

Issue Type:
 
  Improvement 
 
 
 

Assignee:
 

 Unassigned 
 
 
 

Created:
 

 2017/01/11 12:17 PM 
 
 
 

Priority:
 
  Normal 
 
 
 

Reporter:
 
 Hailee Kenney 
 
 
 
 
 
 
 
 
 
 
 
 

 
 Add Comment 
 
 
 
 
 
 
 
 
 
 

 
 
 
 
 
 
 
 
 
 

 This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) 
 
 
 
 
  
 
 
 
 
 
 
 
 
   





-- 
You received this message because you are subscribed to the Google Groups "Puppet Bugs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com.
To post to this group, send email to puppet-bugs@googlegroups.com.
Visit this group at https://groups.google.com/group/puppet-bugs.
For more