Ticket #14796 (closed enhancement: fixed)

Opened 8 months ago

Last modified 8 months ago

wxWidgets 2.9.4 - downloaded documentation - #include strings

Reported by: scott.wl.furry Owned by:
Priority: low Milestone: future
Component: documentation Version: 2.9.4
Keywords: local documentation downloaded Cc:
Blocked By: Patch: no
Blocking:

Description

Downloaded for local use a copy of the wxWidgets 2.9.4 documentation from sourceforge. On every class page, the #include directive appears to be a "local path" for the developer's computer. All class pages viewed so far show #include directive like:

#include </home/zeitlin/src/wx/github/interface/wx/XXXXX.h>

Example:
wxApp class page
"local copy" shows:

#include </home/zeitlin/src/wx/github/interface/wx/app.h>

online copy (  http://docs.wxwidgets.org/2.9.4/classwx_app.html ) shows:

#include <wx/app.h>

I think this is just an oops, but I thought it should be mentioned.
Online documentation from  http://docs.wxwidgets.org/2.9.4 appears correct.

Change History

Changed 8 months ago by VZ

  • status changed from new to closed
  • resolution set to fixed

(In [72839]) Deal correctly with wx directory being a symlink in docs generation script.

The script calling Doxygen is smart enough to strip the path of the wxWidgets
directory from the paths of the files, but it didn't do it correctly if this
directory was a symlink.

Fix this by using readlink, if available, to get the canonical name.

Closes #14796.

Changed 8 months ago by scott.wl.furry

Appears to work :)
Made the changes to local copy of regen.sh and re-ran script. Local documentation is showing same #include directive as online documentation.

However, I'm having issues with missing inheritance diagrams. Its an issue on my end.
More reading for me.

Thanks for your efforts!

Changed 8 months ago by robind

  • status changed from closed to reopened
  • resolution deleted

Apparently some versions of readlink do not support the -e parameter.

Checking for /Users/robind/projects/buildbots/osx-10.7-vm-py2.7/build-osx-py27-2/Phoenix/bin/doxygen-1.7.4-darwin...
./regen.sh xml
/usr/bin/readlink
readlink: illegal option -- e
usage: readlink [-n] [file ...]
Finished command: dox (54.15s)

Changed 8 months ago by VZ

  • status changed from reopened to closed
  • resolution set to fixed

(In [72879]) Don't use "readlink -e" in docs generation script, it's not portable.

"readlink" command also exists under OS X but with a completely different
syntax than under Linux, so just use "pwd -P" to get the physical path name
instead, this should hopefully work everywhere as it's POSIX.

Closes #14796.

Note: See TracTickets for help on using tickets.