I have tried running doxygen from my Linux terminal using the commands:
doxygen -g, followed by
doxygen Doxyfile
I then get the corresponding html sub-directory produced in the directory that my original code is stored in. However, when I open the index.html file in Google Chrome, I do not get any results being displayed - I just get a blank page saying My Project Documentation as shown below. Why is this the case?
Have you actually edited the Doxyfile that gets produced? There are a few lines in there that you want to look at:
PROJECT_NAME = "My Project Name"
INPUT += src
Also, when I ran it, I don't specify the Doxyfile, but that's just because Doxyfile is used by default.
Related
According to the official guideline of lldb, the ability to view source code during debug session (using the command source list) is done by setting new pathname for source files.
i.e. if i compiled my project in /tmp on one computer and deployed it on another computer where the source code reside in /Users/Src/ , i should type settings set target.source-map /tmp /Users/Src from running lldb in the deployment machine.
However, what happens if i got the executable from someone else, and don't know the build directory. and maybe the source-code is organized differently from where is was built (but the file contents is the same).
my questions are :
Does lldb know how to search for matching source file recursively in the supplied path ?
How can I get the original pathname form the mach-o executable ?
here's the formal description of the command :
Remap source file pathnames for the debug session. If your source files are no longer located in the same location as when the program was built --- maybe the program was built on a different computer --- you need to tell the debugger how to find the sources at their local file path instead of the build system's file path.
If you know a function name in the code in question, do:
(lldb) image lookup -vn <FunctionName> <BinaryImageNameContainingFunction>
and look for the CompileUnit entry. The path given there is the path lldb got from the debug information.
I am struggling with the following problem. I use doxygen to document my C++ code, and use the README.md to document the main page of my code documentation, via
INPUT += README.md
USE_MDFILE_AS_MAINPAGE = README.md
in my doyxgen configuration file. Everything works, except that the file README.md appears in the "File documentation" section of my generated .pdf out of the refman.tex file (it doesn't appear in the "File list" section), like
8.24 /Users/username/qpp/README.md File Reference . . . . . . 123
This is extremely annoying, as I don't want this file to appear in any file list. Is there any way to remove it? I cannot just add it to the EXCLUDE = list, as if I do, it won't be used anymore to generate the main page.
As of today, I still haven't found an elegant solution. What you can do in case you don't want README.md to appear in the File Reference section inside your .pdf is to manually comment the line
%\input{_r_e_a_d_m_e_8md}
in the generated refman.tex file, and only after that compile the .tex file to produce the final .pdf
latexmk -pdf refman.tex
The issue does not appear in the html generated documentation, only in the latex one.
So while SVG is zoomable and browsable and looks messy, but OK in general:
Include dependency graph inside PDF file (page 195) looks really as a mess:
I auto generate my documentatoion via such script on linux via command like:
doxygen
cd release/latex/
pdflatex refman.tex
makeindex refman.idx
pdflatex refman.tex
That generates HTML and PDF docs for me. How shall I change my doxygen file or script in order to have no "Include dependency graph for ..." inside my tex/PDF files, while still having them inside HTML docs?
There doesn't appear to be a mechanism to do this within the Doxygen configuration file, however you could customize the file between two runs of Doxygen to get the behavior your looking for. For example, you could disable both HTML and LATEX generation in the Doxyfile:
GENERATE_HTML = NO
GENERATE_LATEX = NO
You could then invoke Doxygen twice, once for HTML (with DOT) enabled, and once with LATEX (w/o DOT). In your script this would look something like:
( cat Doxyfile ; echo "GENERATE_HTML = YES" ) | doxygen -
( cat Doxyfile ; echo "GENERATE_LATEX = YES" ; echo "HAVE_DOT = NO" ) | doxygen -
This will disable all DOT based graphics in the tex/PDF output. If you want to include some but not others, you'll need to fine-tune the specific options you want to enable/disable for tex/PDF.
See the Doxygen FAQ for more information about customizing the Doxyfile from the command line.
I have a file that is located at a different path at development time, however at the time of release it will be in a different location. The title of the documentation, after being generated, is set to the development path. Is it possible to manually set the path of the filename?
What I mean about title:
The structure of the documented source file is:
\File\Path\Filename.cpp [Title]
Function prototypes
… (other documented aspects)
For example the file is located at c:\Code\Dev\Filename.cpp during development and during release it is located at c:\SuperFantasticApplication\Code\Filename.cpp.
I’ve tried adding a parameter after the filename at the top of the file (\file [name I want it to be]). However, that does not work.
There's an option in doxygen to turn of using full path names in the documentation. Inside your doxygen configuration file set FULL_PATH_NAMES to NO.
Here's what the documentation says about it:
If the FULL_PATH_NAMES tag is set to
YES doxygen will prepend the full
path before files name in the file
list and in the header files. If set
to NO the shortest path that makes the
file name unique will be used
I'd like to be able to produce a HTML based report from the Results.trx and data.coverage files that MSTest creates. Ideally this would just list any failures, and show some basic coverage stats.
Does anyone know of a tool that does this?
you can use TRXER tool to generate HTML reports from trx file. Download TrxerConsole.exe file from here
Build/Rebuild the project to create .dll file.
If your project name is UnitTest1 then the .dll file name will be UnitTest1.dll. Go to the location of .dll like
C:\Users\NAME\source\repos\UnitTest1 \UnitTest1
\bin\Debug\netcoreapp3.1\UnitTest1.dll
Open Developer command prompt of Visual studio 2019
Run command to set the location
cd
C:\Users\NAME\source\repos\UnitTest1\UnitTest1\bin\Debug\netcoreapp3.1\UnitTest1.dll
Run the Command to Generate trx file:
vstest.console.exe UnitTest1.dll /logger:trx
Trx file will be generated in the folder TestReults which is present in the same location where project dll file is present.
If TrxerConsole.exe is in downloads then run the command to convert into HTML.
Path of trxerconsole.exe file then space then Path of trxfile as below
C:\Users\NAME\Downloads\TrxerConsole.exe C:\Users\NAME\source\repos\DesktopWithMSTest\DesktopWithMSTest\bin\Debug\netcoreapp3.1\TestResults\TestResult.trx
HTML file will be generated in same TestResults Folder.
link to refer
your Reports will look like:
Actually we did that using the open source tool Trx2Html
Its really simple - gets trx file and output html. There are specific versions for VS2005 trx and VS2008 trx.
You can publish to the report server and then the reports will be available from a web interface.
( I did it in PowerShell)
You need this dll
Microsoft.VisualStudio.Coverage.Analysis.dll
then this line will turn .coverage into an xml file (which the .trx already is)
$dataStore = ([Microsoft.VisualStudio.CodeCoverage.CoverageInfoManager]::CreateInfoFromFile("$homeDir\tests.coverage")).BuildDataSet($null)
$dataStore.WriteXml("$homeDir\Coverage.xml")
Then you could use the MsTest xsl file from cruisecontrol.net to put the test results in a nice html format, and I have an XSL for the coverage. WHich won't fit here. I wish they had a way to upload files. Email me alex dot hutton at hotmail, and I can get you the xsl to display that coverage
The trx files are fairly simple xml documents that can easily be processed with XSLT to produce flexible and customized reports.
If you google trx and xslt you'le find a number of examples to get you started.
I have added a codeplex project for this, you can generate the html from trx as well as add code-coverage data to the same report. http://trxtohtml.codeplex.com/
try the new trx2html.codeplex.com it's not based on XSLT, but in LINQ2XML so it's easier to extend
I am writing a simple batch file to convert your XML report into HTML
Pre-requisites
Download trx2html.exe from here
Paste it to any location on your machine where XML file is being generated
Create a report.bat file and paste the code given below
#echo off
::*****************************Constants*****************************************************************
set "trxFileName=TestResult"
set "trx2html_path=C:\Users\Desktop\0.6\TrxerConsole.exe"
::********************************************************************************************
echo ------------------------"Generating test report "----------------------------------------------
%trx2html_path% ".\Results\%trxFileName%"
echo -----------------------"Test Report Generated at location=.\Results\%trxFileName%"------------
pause
I have created a tool to generate html from trx.
The tool is available from Nuget.org.
Install as global tool:
dotnet tool install --global trxlog2html --version 1.0.0
Install as local tool:
dotnet new tool-manifest
dotnet tool install --local trxlog2html --version 1.0.0
Converting the TRX to html file:
After installation, you can convert the trx file to html file with the following command.
dotnet run trxlog2html -i [input trx file path] -o [output html file path]
See the links below for more information.
https://github.com/HikosakaRyo/trxlog2html
https://www.nuget.org/packages/trxlog2html/