bugGNU Octave - Bugs: bug #45152, doxygen macro_expansion failing

 
 

bug #45152: doxygen macro_expansion failing

Submitter:  Carnë Draug <carandraug>
Submitted:  Wed 20 May 2015 03:19:01 PM UTC
   
 
Category:  Configuration and Build System Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Other
Status:  Fixed Assigned to:  None
Originator Name:  Open/Closed:  * Closed
Release:  * dev Operating System:  * GNU/Linux
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Sun 31 May 2015 12:46:19 PM UTC, comment #2: 

Thank you. I have pushed http://hg.savannah.gnu.org/hgweb/octave/rev/35fc5ea83030 as per your changes.

Carnë Draug <carandraug>
Group Member
Sun 31 May 2015 03:11:31 AM UTC, comment #1: 

Looks fine to me. There are some generated header files too, if there are any macros in them that doxygen would need we'd need to add more directories. But this is probably a good start.

Stylewise, I formatted it a little differently to be consistent with the style we use in Makefiles and sorted the list in the C locale, see attached.

(file #34133)

Mike Miller <mtmiller>
Group Member
Wed 20 May 2015 03:19:01 PM UTC, original submission:  

We have all the settings for doxygen to perform macro expansion. This means that, for example, the constructors for dim_vector should appear as:


dim_vector (octave_idx_type d0, octave_idx_type d1, ...)


However, they still appear as


dim_vector (OCT_MAKE_DECL_LIST(octave_idx_type, d, 3))


The problem seems to be that we must define INCLUDE_PATH in the doxygen options or the include fails, which is why it is failing for macros defined in otehr files. I have done this and the example above then works correctly.

I'm uploading the patch here for review since I'm not super familiar with all the autoconf variables we have available for expansion and there may be something better than what I made.

Carnë Draug <carandraug>
Group Member

 

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

Attach Files:
   
   
Comment:
   

Attached Files
file #34062:  doxygen-include-path.cset added by carandraug (2KiB - application/octet-stream)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by mtmiller (Updated the item)
  • -email is unavailable- added by carandraug (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.

     

    Follow 7 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2015-05-31 carandraug StatusPatch Submitted Fixed
        Open/ClosedOpen Closed
    2015-05-31 mtmiller Attached File- Added oct-doxygen-include-path.diff, #34133
        Item GroupNone Other
        StatusNone Patch Submitted
        Release4.0.0-rc4 dev
    2015-05-20 carandraug Attached File- Added doxygen-include-path.cset, #34062

    Back to the top

    Powered by Savane 3.13-758e.
    Corresponding source code