mirror of
https://github.com/NationalSecurityAgency/ghidra.git
synced 2024-11-25 13:42:06 +00:00
Reworking decompiler documentation
This commit is contained in:
caheckman
parent
7e5f015d65
commit
31e712b993
@ -10,8 +10,12 @@ src/decompile/build.gradle||GHIDRA||||END|
|
||||
src/decompile/cpp/.gitignore||GHIDRA||||END|
|
||||
src/decompile/cpp/Doxyfile||GHIDRA|||Most of this file is autogenerated by doxygen which falls under the GPL - output from GPL products are NOT GPL! - mjbell4|END|
|
||||
src/decompile/cpp/Makefile||GHIDRA||||END|
|
||||
src/main/doc/Makefile||GHIDRA|exclude|||END|
|
||||
src/main/doc/cspec.xml||GHIDRA|exclude|||END|
|
||||
src/main/doc/cspec_html.xsl||GHIDRA|exclude|||END|
|
||||
src/main/doc/decompileplugin.xml||GHIDRA|exclude|||END|
|
||||
src/main/doc/decompileplugin_common.xsl||GHIDRA|exclude|||END|
|
||||
src/main/doc/decompileplugin_html.xsl||GHIDRA|exclude|||END|
|
||||
src/main/doc/main.xml||GHIDRA|exclude|reviewed||END|
|
||||
src/main/doc/main_html.xsl||GHIDRA|exclude|reviewed||END|
|
||||
src/main/doc/pcoderef.xml||GHIDRA|exclude|||END|
|
||||
|
||||
20
Ghidra/Features/Decompiler/src/main/doc/Makefile
Normal file
20
Ghidra/Features/Decompiler/src/main/doc/Makefile
Normal file
@ -0,0 +1,20 @@
|
||||
|
||||
BUILDDIR=html
|
||||
|
||||
Decompiler.html: decompileplugin.xml
|
||||
rm -rf ${BUILDDIR}
|
||||
mkdir ${BUILDDIR}
|
||||
mkdir ${BUILDDIR}/images
|
||||
cp ../../../src/main/help/help/shared/Frontpage.css ${BUILDDIR}
|
||||
cp ../../../src/main/help/help/shared/languages.css ${BUILDDIR}
|
||||
cp ../../../src/main/help/help/topics/DecompilePlugin/images/DecompWindow.png ${BUILDDIR}/images
|
||||
cp ../../../src/main/help/help/topics/DecompilePlugin/images/EditFunctionSignature.png ${BUILDDIR}/images
|
||||
cp ../../../src/main/help/help/topics/DecompilePlugin/images/ForwardSlice.png ${BUILDDIR}/images
|
||||
cp ../../../src/main/help/help/topics/DecompilePlugin/images/decompileFunction.gif ${BUILDDIR}/images
|
||||
cp ../../../src/main/help/help/topics/DecompilePlugin/images/page_edit.png ${BUILDDIR}/images
|
||||
cp ../../../../Base/src/main/help/help/topics/Snapshots/images/camera-photo.png ${BUILDDIR}/images
|
||||
cp ../../../../Base/src/main/help/help/topics/ClipboardPlugin/images/page_white_copy.png ${BUILDDIR}/images
|
||||
cp ../../../../../Framework/Generic/src/main/resources/images/reload3.png ${BUILDDIR}/images
|
||||
cp ../../../src/main/help/help/shared/note.png ${BUILDDIR}/images
|
||||
xsltproc --stringparam base.dir ${BUILDDIR} --stringparam root.filename Decompiler decompileplugin_html.xsl decompileplugin.xml
|
||||
sed -i -e '/Frontpage.css/ { p; s/Frontpage.css/languages.css/; }' ${BUILDDIR}/*.html
|
||||
2942
Ghidra/Features/Decompiler/src/main/doc/decompileplugin.xml
Normal file
2942
Ghidra/Features/Decompiler/src/main/doc/decompileplugin.xml
Normal file
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,59 @@
|
||||
<?xml version='1.0'?>
|
||||
<xsl:stylesheet
|
||||
xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
||||
|
||||
<xsl:param name="generate.toc">
|
||||
article/appendix nop
|
||||
article title
|
||||
book title,example,equation
|
||||
chapter nop
|
||||
part toc,title
|
||||
preface toc,title
|
||||
qandadiv toc
|
||||
qandaset toc
|
||||
reference toc,title
|
||||
sect1 nop
|
||||
sect2 nop
|
||||
sect3 nop
|
||||
sect4 nop
|
||||
sect5 nop
|
||||
section nop
|
||||
set toc,title
|
||||
</xsl:param>
|
||||
|
||||
<!-- Turn off automatic table numbering, adjust xref labeling -->
|
||||
<xsl:param name="local.l10n.xml" select="document('')"/>
|
||||
<l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">
|
||||
<l:l10n language="en">
|
||||
<l:context name="title">
|
||||
<l:teamplate name="table" text="%t"/>
|
||||
</l:context>
|
||||
<l:context name="xref-number-and-title">
|
||||
<l:template name="table" text="the table titled “%t”"/>
|
||||
</l:context>
|
||||
<l:context name="xref">
|
||||
<l:template name="sect1" text="“%t”"/>
|
||||
<l:template name="sect2" text="“%t”"/>
|
||||
<l:template name="sect3" text="“%t”"/>
|
||||
<l:template name="sect4" text="“%t”"/>
|
||||
<l:template name="sect5" text="“%t”"/>
|
||||
<l:template name="section" text="“%t”"/>
|
||||
<l:template name="simplesect" text="“%t”"/>
|
||||
</l:context>
|
||||
</l:l10n>
|
||||
</l:i18n>
|
||||
|
||||
<xsl:template match="table" mode="label.markup"/>
|
||||
|
||||
<xsl:param name="chapter.autolabel" select="0"/>
|
||||
|
||||
<xsl:param name="formal.title.placement"> <!-- Where does the title go, relative to the object -->
|
||||
figure after
|
||||
example before
|
||||
equation before
|
||||
table before
|
||||
procedure before
|
||||
task before
|
||||
</xsl:param>
|
||||
|
||||
</xsl:stylesheet>
|
||||
@ -0,0 +1,56 @@
|
||||
<?xml version='1.0'?>
|
||||
<xsl:stylesheet
|
||||
xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
||||
|
||||
<xsl:import href="/usr/share/sgml/docbook/xsl-stylesheets/html/chunk.xsl"/>
|
||||
|
||||
<xsl:include href="decompileplugin_common.xsl" />
|
||||
|
||||
<!-- Bump up the heading levels so that "chapter" gets and h1 header -->
|
||||
|
||||
<xsl:template name="component.title">
|
||||
<xsl:param name="node" select="."/>
|
||||
|
||||
<xsl:variable name="level">
|
||||
<xsl:choose>
|
||||
<xsl:when test="ancestor::section">
|
||||
<xsl:value-of select="count(ancestor::section)+1"/>
|
||||
</xsl:when>
|
||||
<xsl:when test="ancestor::sect">6</xsl:when>
|
||||
<xsl:when test="ancestor::sect">5</xsl:when>
|
||||
<xsl:when test="ancestor::sect">4</xsl:when>
|
||||
<xsl:when test="ancestor::sect">3</xsl:when>
|
||||
<xsl:when test="ancestor::sect">2</xsl:when>
|
||||
<xsl:otherwise>1</xsl:otherwise>
|
||||
</xsl:choose>
|
||||
</xsl:variable>
|
||||
|
||||
<!-- Let's handle the case where a component (bibliography, for example)
|
||||
occurs inside a section; will we need parameters for this? -->
|
||||
|
||||
<xsl:element name="h{$level}">
|
||||
<xsl:attribute name="class">title</xsl:attribute>
|
||||
<xsl:call-template name="anchor">
|
||||
<xsl:with-param name="node" select="$node"/>
|
||||
<xsl:with-param name="conditional" select="0"/>
|
||||
</xsl:call-template>
|
||||
<xsl:apply-templates select="$node" mode="object.title.markup">
|
||||
<xsl:with-param name="allow-anchors" select="1"/>
|
||||
</xsl:apply-templates>
|
||||
</xsl:element>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:param name="use.id.as.filename" select="1"/> <!-- Split up into files based on id attribute -->
|
||||
|
||||
<xsl:param name="html.stylesheet" select="'Frontpage.css'"/> <!-- Use our custom cascading style sheet -->
|
||||
|
||||
<xsl:param name="chunk.section.depth" select="0"/>
|
||||
|
||||
<xsl:param name="chunker.output.indent" select="'yes'"/> <!-- Do proper indenting of html -->
|
||||
|
||||
<xsl:param name="admon.graphics" select="1"/> <!-- Turn on graphic icon for important/note tags -->
|
||||
|
||||
<xsl:param name="admon.textlabel" select="0"/> <!-- Don't display title for important/note tags -->
|
||||
|
||||
<!-- <xsl:param name="admon.graphics.path" select="shared/"/> -->
|
||||
</xsl:stylesheet>
|
||||
Loading…
Reference in New Issue
Block a user