mirror of
https://github.com/OPM/ResInsight.git
synced 2025-02-25 18:55:39 -06:00
Added complete VizFwk
Added the complete VizFwk from the ResInsight branch in Perforce as of changelist 190.
This commit is contained in:
44
Fwk/VizFwk/Doxygen/!Doxygen.vcxproj
Normal file
44
Fwk/VizFwk/Doxygen/!Doxygen.vcxproj
Normal file
@@ -0,0 +1,44 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||||
<ItemGroup Label="ProjectConfigurations">
|
||||
<ProjectConfiguration Include="Doxygen|Win32">
|
||||
<Configuration>Doxygen</Configuration>
|
||||
<Platform>Win32</Platform>
|
||||
</ProjectConfiguration>
|
||||
</ItemGroup>
|
||||
<PropertyGroup Label="Globals">
|
||||
<ProjectGuid>{F5FA2496-1AD3-4569-8EA1-5B5F01450B03}</ProjectGuid>
|
||||
<RootNamespace>Doxygen</RootNamespace>
|
||||
</PropertyGroup>
|
||||
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
|
||||
<PropertyGroup Label="Configuration" Condition="'$(Configuration)|$(Platform)'=='Doxygen|Win32'">
|
||||
<ConfigurationType>Utility</ConfigurationType>
|
||||
</PropertyGroup>
|
||||
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
|
||||
<ImportGroup Label="ExtensionSettings">
|
||||
</ImportGroup>
|
||||
<PropertyGroup Label="UserMacros" />
|
||||
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Doxygen|Win32'">
|
||||
<OutDir>$(ProjectDir)\html\</OutDir>
|
||||
</PropertyGroup>
|
||||
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Doxygen|Win32'">
|
||||
<IntDir>$(ProjectDir)\html\</IntDir>
|
||||
</PropertyGroup>
|
||||
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Doxygen|Win32'">
|
||||
<ExtensionsToDeleteOnClean>*.html;*.css;*.map;*.md5;*.dot;*.png;*.gif;*.js;installdox</ExtensionsToDeleteOnClean>
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<None Include="CeetronDoxygenGuidelines.txt" />
|
||||
<None Include="html\index.html" />
|
||||
<CustomBuild Include="RunDoxygen.bat">
|
||||
<FileType>Document</FileType>
|
||||
<Command Condition="'$(Configuration)|$(Platform)'=='Doxygen|Win32'">RunDoxygen.bat</Command>
|
||||
<Message Condition="'$(Configuration)|$(Platform)'=='Doxygen|Win32'">Running Doxygen...</Message>
|
||||
<Outputs Condition="'$(Configuration)|$(Platform)'=='Doxygen|Win32'">html/ToForceRebuildEveryTime.html</Outputs>
|
||||
</CustomBuild>
|
||||
<None Include="VizDoxygenSetup" />
|
||||
</ItemGroup>
|
||||
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
|
||||
<ImportGroup Label="ExtensionTargets">
|
||||
</ImportGroup>
|
||||
</Project>
|
||||
11
Fwk/VizFwk/Doxygen/!Doxygen.vcxproj.filters
Normal file
11
Fwk/VizFwk/Doxygen/!Doxygen.vcxproj.filters
Normal file
@@ -0,0 +1,11 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||||
<ItemGroup>
|
||||
<None Include="CeetronDoxygenGuidelines.txt" />
|
||||
<None Include="html\index.html" />
|
||||
<None Include="VizDoxygenSetup" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<CustomBuild Include="RunDoxygen.bat" />
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
42
Fwk/VizFwk/Doxygen/CeetronDoxygenGuidelines.txt
Normal file
42
Fwk/VizFwk/Doxygen/CeetronDoxygenGuidelines.txt
Normal file
@@ -0,0 +1,42 @@
|
||||
|
||||
Documentation guidelines when writing Doxygen doc for CVC.
|
||||
-------------------------------------------------------------
|
||||
|
||||
Ripped from: http://api.haiku-os.org/apidoc.html
|
||||
|
||||
Relevant paragraph commands in decreasing order of importance:
|
||||
|
||||
\attention
|
||||
* Used when the developer is bound to make a mistake, when the API is ambiguous.
|
||||
The difference between this and a warning is that warnings warn about things
|
||||
that are the developers fault, and attention blocks warn about things that
|
||||
might go wrong because of the way the API is structured.
|
||||
* Used to warn for abuse of the API that might be caused by the way the internals
|
||||
of the system are structured.
|
||||
|
||||
\warning
|
||||
* Used to warn developers about using the API in a certain way. Warnings apply
|
||||
especially to new developers that aren't completely familiar with the API and that
|
||||
might want to abuse it. For example, the thread safety of BString requires a warning.
|
||||
|
||||
\note
|
||||
* Used to place references to other documentation that might not be directly related
|
||||
to the text. For example, BLooper will have a direct reference to BHandler in the
|
||||
class description, but BMessenger will be mentioned in a note because it does not
|
||||
directly influence the use of the class.
|
||||
* Can also be used for useful hints or notes that somehow need to stand out from the
|
||||
rest of the text.
|
||||
|
||||
\remark
|
||||
* Remarks are small notes that would interrupt the flow of the text. For example,
|
||||
if you in a text ignore a certain condition that is so extremely rare and uncommon,
|
||||
you can put a remark at the end of the text to tell that you have been lying.
|
||||
* Remarks interact with the text whereas notes add something unmentioned to it.
|
||||
|
||||
|
||||
In newer versions of Doxygen it seems that these gets tagged with a color in the
|
||||
final documentation.
|
||||
RED \attention
|
||||
RED \warning
|
||||
YELLOW \note
|
||||
nocolor \remark
|
||||
2
Fwk/VizFwk/Doxygen/RunDoxygen.bat
Normal file
2
Fwk/VizFwk/Doxygen/RunDoxygen.bat
Normal file
@@ -0,0 +1,2 @@
|
||||
..\Tools\Doxygen\doxygen.exe VizDoxygenSetup
|
||||
pause
|
||||
1766
Fwk/VizFwk/Doxygen/VizDoxygenSetup
Normal file
1766
Fwk/VizFwk/Doxygen/VizDoxygenSetup
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user