AS& Doxygen intetgration

Go To Last Post
11 posts / 0 new
Author
Message
#1
  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

Trying to integrate Doxygen with AS7

 

I have installed the Doxygen extension:

Doxygen

 

And the documentation on Microchip.com  suggest that is all I need to do.

However when I use the Project / Doxygen menu item I get an error message telling me that "Doxygen is not configured". Fair enough, I go to Tools / Options / Documentation / Doxygen and it looks like it needs the executable path. Trouble is I cannot find a doxygen executable on my system. 

 

Hmmmm. Any ideas? Should I just abandon the extension and install it externally instead?

 

SpiderKenny
@spiderelectron
www.spider-e.com

 

  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

I see exactly the same. When I go to the Extensions menu it shows a green tick on Doxygen though I don't remember ever asking it to be added. When I try to use

 

It shows:

 

 

And yet:

C:\Program Files (x86)\Atmel\Studio\7.0>dir dox*.* /s
 Volume in drive C is OSDISK
 Volume Serial Number is 7AF3-B2D0

 Directory of C:\Program Files (x86)\Atmel\Studio\7.0\Extensions\atmel\as-asf-vsix\7.0.1184\Scripts\tools\project_generator\asf\test-input

24/09/2018  12:01    <DIR>          doxygen_test
18/06/2018  12:35             4,009 doxygen_test.xml
               1 File(s)          4,009 bytes

 Directory of C:\Program Files (x86)\Atmel\Studio\7.0\Extensions\atmel\as-asf-vsix\7.0.1184\Scripts\tools\project_generator\asf\toolchain

18/06/2018  12:35            10,038 doxygen.py
18/06/2018  12:35             5,950 doxygen_v2.py
               2 File(s)         15,988 bytes

 Directory of C:\Program Files (x86)\Atmel\Studio\7.0\Extensions\atmel\as-asf-vsix\7.0.1184\Scripts\tools\project_generator\templates

18/06/2018  12:35            70,620 doxyfile.doxygen
18/06/2018  12:35            83,601 doxyfile_v2.doxygen
24/09/2018  12:01    <DIR>          doxygen_mainpage
18/06/2018  12:35             2,004 doxygen_module_mainpage.h
18/06/2018  12:35             6,308 doxygen_v2_layout.xml
18/06/2018  12:35             1,894 doxygen_v2_module_mainpage.h
               5 File(s)        164,427 bytes

 Directory of C:\Program Files (x86)\Atmel\Studio\7.0\Extensions\atmel\as-asf-vsix\7.0.1184\Scripts\tools\project_generator\templates\docbook_pdf

18/06/2018  12:35               723 doxygen2dita_asf_manual.xsl
18/06/2018  12:35            57,676 doxygen2dita_base.xsl
18/06/2018  12:35            13,163 doxygen2dita_module.xsl
18/06/2018  12:35            13,624 doxygen2dita_project.xsl
18/06/2018  12:35            12,556 doxygen2dita_resources.xsl
18/06/2018  12:35            22,818 doxygen2dita_scripts.py
               6 File(s)        120,560 bytes

 Directory of C:\Program Files (x86)\Atmel\Studio\7.0\Extensions\atmel\as-asf-vsix\7.0.1184\Scripts\tools\project_generator\templates\doxygen_mainpage

18/06/2018  12:35            25,211 doxygen.css
18/06/2018  12:35             5,879 DoxygenLayout.xml
18/06/2018  12:35               275 doxygen_footer.html
18/06/2018  12:35             4,355 doxygen_header.html
               4 File(s)         35,720 bytes

 Directory of C:\Program Files (x86)\Atmel\Studio\7.0\Extensions\atmel\as-asf-vsix\7.0.1184\Scripts\tools\project_generator\templates\generate_master_doxygen

18/06/2018  12:35             2,335 doxygen_master_mainpage.h
               1 File(s)          2,335 bytes

 Directory of C:\Program Files (x86)\Atmel\Studio\7.0\packs\arm\cmsis\4.2.0\CMSIS\Documentation\Core\html

18/06/2018  10:44             3,835 doxygen.png
               1 File(s)          3,835 bytes

 Directory of C:\Program Files (x86)\Atmel\Studio\7.0\packs\arm\cmsis\5.0.1\CMSIS\Documentation\Core\html

18/06/2018  10:44            23,935 doxygen.css
18/06/2018  10:44             3,835 doxygen.png
               2 File(s)         27,770 bytes

 Directory of C:\Program Files (x86)\Atmel\Studio\7.0\toolchain\avr8\avr8-gnu-toolchain\doc\avr-libc\avr-libc-user-manual

12/09/2017  23:24             7,911 doxygen.css
12/09/2017  23:24               849 doxygen.png
               2 File(s)          8,760 bytes

     Total Files Listed:
              24 File(s)        383,404 bytes

These is no exe file for doxygen to enter into that tools-options dialog.

 

Wonder if it would help to tell "Extensions" to remove it and then try installing it a second time?

  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

@clawson - Thanks for the quick reply.

I see exactly the same - yet no .exe in that bunch.

I removed the extension / restarted  AS7 / re-installed extension / Restart AS7 and got the same results as before.

 

I have now downloaded the doxygen windows installer from doxygen.org and set the executable path in AS7 and it's working now :-)

SpiderKenny
@spiderelectron
www.spider-e.com

 

  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

Oh maybe this is the point (it would help if there were a manual!). Perhaps you ARE expected to get the EXE separately and this GUI stuff is just a graphic wrapper to invoke it ?

  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

OK so there IS a manual....

 

https://www.microchip.com/webdoc...

 

That clearly says there is a copy of the exe in the VSIX but what seems to be missing is the step to get it out of the VSIX and into a location that can be entered in the dialog ??

  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

That page also states "And if you choose to use that executable the path is preconfigured." when referring to the VSIX

Looks like the VSIX and/or documentation are a bit stale.

 

 

SpiderKenny
@spiderelectron
www.spider-e.com

 

  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

This is curious:

C:\Program Files (x86)\Atmel\Studio\7.0\Extensions>tree
Folder PATH listing for volume OSDISK
Volume serial number is 7AF3-B2D0
C:.
├───Application
│   ├───CppParser
│   │   └───cpp
│   └───en
├───atmel
│   ├───acme-studio
│   │   └───7.0.158
│   │       └───locales
│   ├───as-asf-vsix
│   │   └───7.0.1184
│   │       ├───extensions
│   │       │   ├───3.34.1
│   │       │   ├───3.34.2
│   │       │   ├───3.35.1
│   │       │   ├───3.36.0
│   │       │   ├───3.36.1
│   │       │   ├───3.36.2
│   │       │   ├───3.37
│   │       │   ├───3.38.0
│   │       │   ├───3.39.0
│   │       │   └───3.40.0
│   │       ├───Help
│   │       ├───Icons
│   │       ├───NativeBinaries
│   │       │   ├───amd64
│   │       │   └───x86
│   │       ├───ProjectTemplates
│   │       │   └───CandCPP
│   │       │       └───1033
│   │       ├───Repository
│   │       │   └───Asf.git
│   │       │       ├───hooks
│   │       │       ├───info
│   │       │       ├───objects
│   │       │       │   ├───info
│   │       │       │   └───pack
│   │       │       └───refs
│   │       │           ├───heads
│   │       │           └───tags
│   │       ├───Resources
│   │       ├───Scripts
│   │       │   └───tools
│   │       │       └───project_generator
│   │       │           ├───asf
│   │       │           │   ├───test-input
│   │       │           │   │   ├───dist_dir
│   │       │           │   │   ├───doxygen_test
│   │       │           │   │   │   └───cmsis
│   │       │           │   │   ├───extensions
│   │       │           │   │   │   ├───Aaa
│   │       │           │   │   │   │   └───Bbb
│   │       │           │   │   │   ├───Ccc
│   │       │           │   │   │   │   └───misplaced_ASF
│   │       │           │   │   │   └───Eee
│   │       │           │   │   └───studio_integration
│   │       │           │   └───toolchain
│   │       │           ├───device_maps
│   │       │           ├───docs
│   │       │           ├───libs
│   │       │           ├───schemas
│   │       │           ├───templates
│   │       │           │   ├───docbook_pdf
│   │       │           │   ├───doxygen_mainpage
│   │       │           │   │   └───images
│   │       │           │   └───generate_master_doxygen
│   │       │           └───xmlrunner
│   │       │               ├───extra
│   │       │               └───tests
│   │       │                   └───fixtures
│   │       └───~PC
│   │           └───ProjectTemplates
│   │               └───CandCPP
│   │                   └───1033
│   │                       └───BoardProjectTemplate.zip
│   ├───as-extension-livewatch
│   │   └───2.0.65
│   │       └───Resources
│   ├───as-gdbconsole-vsix
│   │   └───7.0.188
│   ├───as-vsix-atmelkits
│   │   └───7.0.122
│   ├───as-vsix-toolchain-provider
│   │   └───7.0.895
│   │       ├───Help
│   │       ├───Icons
│   │       ├───ProjectTemplates
│   │       │   ├───Assembler
│   │       │   └───CandCPP
│   │       ├───Resources
│   │       └───~PC
│   │           └───ProjectTemplates
│   │               ├───Assembler
│   │               │   └───Assembler.zip
│   │               └───CandCPP
│   │                   ├───Avrgcc.zip
│   │                   ├───AvrgccStaticLibrary.zip
│   │                   ├───Avrgcc_cpp_exe.zip
│   │                   └───Avrgcc_cpp_lib.zip
│   └───DataVisualizer
│       └───2.18.723
├───Microchip
│   └───Gallery
│       └───8.0.16
│           └───Resources
└───WholeTomato
    └───VA_Atmel
        └───10.9.2093.2
            ├───1033
            ├───About
            ├───Autotext
            │   └───Latest
            ├───Dict
            ├───Misc
            ├───OptionsHelp
            │   ├───About
            │   ├───ButtonsAndIcons
            │   │   └───images
            │   ├───CodeGeneration
            │   │   └───images
            │   ├───Cpp6
            │   ├───CPPDirectories
            │   ├───Debug
            │   ├───Display
            │   │   └───images
            │   ├───Editor
            │   ├───FontsAndColors
            │   │   └───images
            │   ├───Highlighting
            │   │   └───images
            │   ├───License
            │   ├───ListBoxes
            │   │   └───images
            │   ├───Mouse
            │   ├───PerfGeneral
            │   ├───ProjectsAndFiles
            │   │   └───images
            │   ├───Startup
            │   ├───Suggestions
            │   │   └───images
            │   ├───Underlining
            │   │   └───images
            │   └───_shared
            │       ├───css
            │       └───images
            └───TipOfTheDay
                ├───css
                └───images

While it seems I have "Doxygen" there's no evidence of it here at all - which seems "odd" ?!?

  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

It might be in the "other" folder "C:\Program Files" ? (I can never remember which is 32-bit and which is 64-bit)

SpiderKenny
@spiderelectron
www.spider-e.com

 

  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

Doxygen is a per-user extension so it will be available in %localappdata%\Atmel\AtmelStudio\7.0\Extensions

 

Regards,

Charles

  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

Oh yeah - finally found it...

C:\Users\uid23021\AppData\Local\Atmel\AtmelStudio\7.0\Extensions>tree /f
Folder PATH listing for volume OSDISK
Volume serial number is 7AF3-B2D0
C:.
│   CompatibilityList.xml
│   extensions.en-US.cache
│   extensionSdks.en-US.cache
│
└───m5qzefym.q0h
    │   Atmel.Studio.Services.Interfaces.dll
    │   DoxygenIntegrator.dll
    │   DoxygenIntegrator.pkgdef
    │   extension.vsixmanifest
    │   Help.pdf
    │   Licence.txt
    │
    ├───Doxygen
    │       doxygen.exe
    │
    └───Icons
            Doxy.png
            Preview.png

So when the .vsix for Doxygen is added to AS7 why doesn't it automatically set the EXE path for Doxygen to this location ?? I doubt anyone is going to just "stumble" upon this (unless they just search all their drives for "doxygen.exe")

  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

I will pass on the feedback to extension developer.

 

Regards,

Charles