bugGNU Octave - Bugs: bug #53874, doc_cache_create doesnt handle...

 
 

bug #53874: doc_cache_create doesnt handle classdef documentation

Submitted by:  John Donoghue <lostbard>
Submitted on:  Thu 10 May 2018 08:37:11 PM UTC  
 
Category:  Octave Function Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Inaccurate Result
Status:  None Assigned to:  None
Originator Name:  JohnD Open/Closed:  Open
Release:  4.4.0 Operating System:  Any

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Thu 05 Jul 2018 09:01:08 PM UTC, comment #3:

In addition any functions defined within the classdef both in the classdef file, and in @classname/functionX.m do not register for help, unlike older class functions.

John Donoghue <lostbard>
Project Member
Thu 05 Jul 2018 07:47:25 PM UTC, comment #2:

Although more specifically could deal with packages etc, where the help will not appear through help or doc, nor be included in generated docs from generate_html

John Donoghue <lostbard>
Project Member
Sun 20 May 2018 12:40:25 PM UTC, comment #1:

I guess is a duplicate of #43047

John Donoghue <lostbard>
Project Member
Thu 10 May 2018 08:37:11 PM UTC, original submission:

There doesn't seem to be anyway for classdef files to have help documentation.

Any texinfo documentation in the file does not appear to get used, giving a warning message of doc_cache_create: unusable help text found in file

John Donoghue <lostbard>
Project Member

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by lostbard (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

     

     

    No changes have been made to this item

    Back to the top


    Powered by Savane 3.3