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

 
 

bug #45152: doxygen macro_expansion failing

Submitted by:  Carnë Draug <carandraug>
Submitted on:  Wed 20 May 2015 03:19:01 PM UTC  
 
Category: Configuration and Build SystemSeverity: 3 - Normal
Priority: 5 - NormalItem Group: Other
Status: FixedAssigned to: None
Originator Name: Open/Closed: Closed
Release: devOperating System: GNU/Linux

Add a New Comment(Rich Markup)
   

You are not logged in

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

 

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>
Project 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>
Project Administrator
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:

However, they still appear as

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>
Project Member

 

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

Attach File(s):
   
   
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
  • -unavailable- added by mtmiller (Updated the item)
  • -unavailable- added by carandraug (Submitted the item)
  •  

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

    Only project members can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 7 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Sun 31 May 2015 12:46:19 PM UTCcarandraugStatusPatch Submitted=>Fixed
      Open/ClosedOpen=>Closed
    Sun 31 May 2015 03:11:31 AM UTCmtmillerAttached File-=>Added oct-doxygen-include-path.diff, #34133
      Item GroupNone=>Other
      StatusNone=>Patch Submitted
      Release4.0.0-rc4=>dev
    Wed 20 May 2015 03:19:01 PM UTCcarandraugAttached File-=>Added doxygen-include-path.cset, #34062

    Back to the top


    Powered by Savane 3.1-cleanup1