Jump to content
Toggle sidebar
Search
English
Log in
Personal tools
Log in
Index
Overview
Features
Screenshots
Download
FAQ
Forum
Tracker
General usage
User Hub
Manual
Tutorials
Installing
Getting started
Navigation styles
Customizing FreeCAD
Commands list
Workbenches
Workbenches list
Assembly
BIM/Arch
CAM/Path
Draft
FEM
Inspection
Material
Mesh
OpenSCAD
Part
PartDesign
Points
Reverse Engineering
Robot
Sketcher
Spreadsheet
Surface
TechDraw
External workbenches
Python scripting
Powerusers hub
Discovering Python
Python in FreeCAD
Macros
Mesh scripting
Part scripting
Pivy
PySide
Parametric objects
Code examples
Python API
Development
Developers hub
How to contribute
Git repository
Compiling
License details
Organization chart
Startup options
Branding
Translating
Help & Feedback
Forum
Bugs tracker
IRC channel
Facebook
Twitter
Mastodon
Meta
Recent changes
Random page
Links
Tools
Special pages
Printable version
Export translations
Translate
English
Language statistics
Message group statistics
Export
More
Language statistics
Message group statistics
Export
Settings
Group
3D input devices
3D view
3Dconnexion input devices
A2plus Workbench
About FreeCAD
Add Button to FEM Toolbar Tutorial
Add FEM Constraint Tutorial
Add FEM Equation Tutorial
Add Workbench to Addon Manager
Addon
Advanced Attachment OYX
Advanced TechDraw Tutorial
Aeroplane
Analysis of reinforced concrete with FEM
Animation Workbench
ANSI templates
App DocumentObject
App DocumentObjectGroup
App FeaturePython
App GeoFeature
App Link
App OriginGroupExtension
App Part
AppImage
Arch 3DS
Arch 3Views
Arch Add
Arch API
Arch Axis
Arch AxisSystem
Arch Building
Arch BuildingPart
Arch Check
Arch CloneComponent
Arch CloseHoles
Arch Component
Arch CurtainWall
Arch CutLine
Arch CutPlane
Arch DAE
Arch Equipment
Arch Fence
Arch Floor
Arch Frame
Arch Grid
Arch IFC
Arch IfcSpreadsheet
Arch JSON
Arch MergeWalls
Arch MeshToShape
Arch MultiMaterial
Arch Nest
Arch OBJ
Arch Panel
Arch Panel Cut
Arch Panel Sheet
Arch panel tutorial
Arch Pipe
Arch PipeConnector
Arch Profile
Arch Project
Arch Rebar
Arch Reference
Arch Remove
Arch RemoveShape
Arch Roof
Arch Schedule
Arch SectionPlane
Arch SelectNonSolidMeshes
Arch SetMaterial
Arch SHP
Arch Site
Arch Space
Arch SplitMesh
Arch Stairs
Arch Structure
Arch Survey
Arch templates
Arch ToggleIfcBrepFlag
Arch ToggleSubs
Arch Truss
Arch tutorial
Arch Wall
Arch Window
Arch Workbench
Artwork
Artwork Assembly
Artwork Assembly3
Artwork BIM
Artwork CAM
Artwork Draft
Artwork Fem
Artwork Gui
Artwork Guidelines
Artwork Inspection
Artwork Material
Artwork Mesh
Artwork MeshPart
Artwork OpenSCAD
Artwork Part
Artwork PartDesign
Artwork Plot
Artwork Points
Artwork Reinforcement
Artwork Render
Artwork ReverseEngineering
Artwork Robot
Artwork Ship
Artwork Sketcher
Artwork Splash screen
Artwork Spreadsheet
Artwork Surface
Artwork TechDraw
Artwork Test
Artwork Tux
Assembly
Assembly CreateAssembly
Assembly CreateBom
Assembly CreateJointAngle
Assembly CreateJointBall
Assembly CreateJointBelt
Assembly CreateJointCylindrical
Assembly CreateJointDistance
Assembly CreateJointFixed
Assembly CreateJointGears
Assembly CreateJointParallel
Assembly CreateJointPerpendicular
Assembly CreateJointRackPinion
Assembly CreateJointRevolute
Assembly CreateJointScrew
Assembly CreateJointSlider
Assembly CreateView
Assembly ExportASMT
Assembly InsertLink
Assembly SolveAssembly
Assembly ToggleGrounded
Assembly Workbench
Assembly2 Workbench
Assembly3 AddOrigin
Assembly3 AddPlacement
Assembly3 AddWorkplane
Assembly3 AddXZWorkplane
Assembly3 AddZYWorkplane
Assembly3 AutoElementVisibility
Assembly3 AutoFixElement
Assembly3 AutoRecompute
Assembly3 AxialMove
Assembly3 ConstraintAlignment
Assembly3 ConstraintAngle
Assembly3 ConstraintArcLineTangent
Assembly3 ConstraintAttachment
Assembly3 ConstraintAttachmentOffset
Assembly3 ConstraintAxial
Assembly3 ConstraintCoincidence
Assembly3 ConstraintColinear
Assembly3 ConstraintDiameter
Assembly3 ConstraintEqualAngle
Assembly3 ConstraintEqualLength
Assembly3 ConstraintEqualLineArcLength
Assembly3 ConstraintEqualPointLineDistance
Assembly3 ConstraintEqualRadius
Assembly3 ConstraintLengthDifference
Assembly3 ConstraintLengthEqualPointLineDistance
Assembly3 ConstraintLengthRatio
Assembly3 ConstraintLineHorizontal
Assembly3 ConstraintLineLength
Assembly3 ConstraintLineVertical
Assembly3 ConstraintLock
Assembly3 ConstraintMidPoint
Assembly3 ConstraintMore
Assembly3 ConstraintMultiParallel
Assembly3 ConstraintPerpendicular
Assembly3 ConstraintPointDistance
Assembly3 ConstraintPointInPlane
Assembly3 ConstraintPointLineDistance
Assembly3 ConstraintPointOnCircle
Assembly3 ConstraintPointOnLine
Assembly3 ConstraintPointPlaneDistance
Assembly3 ConstraintPointsCoincident
Assembly3 ConstraintPointsDistance
Assembly3 ConstraintPointsHorizontal
Assembly3 ConstraintPointsProjectDistance
Assembly3 ConstraintPointsSymmetric
Assembly3 ConstraintPointsVertical
Assembly3 ConstraintSameOrientation
Assembly3 ConstraintSketchPlane
Assembly3 ConstraintSymmetric
Assembly3 ConstraintSymmetricHorizontal
Assembly3 ConstraintSymmetricLine
Assembly3 ConstraintSymmetricVertical
Assembly3 CreateAssembly
Assembly3 CreateElement
Assembly3 GoToRelation
Assembly3 GroupObjects
Assembly3 ImportFromSTEP
Assembly3 ImportMultiDocument
Assembly3 LockMover
Assembly3 MeasureAngle
Assembly3 MeasurePointLine
Assembly3 MeasurePointPlane
Assembly3 MeasurePoints
Assembly3 MoveItemDown
Assembly3 MoveItemUp
Assembly3 MovePart
Assembly3 MultiplyConstraint
Assembly3 QuickMove
Assembly3 QuickSolve
Assembly3 ResolveConstraints
Assembly3 ShowElementCS
Assembly3 SmartRecompute
Assembly3 TogglePartVisibility
Assembly3 TracePartMove
Assembly3 Workbench
Assembly4 Workbench
Asymptote
B-Splines
Base API
Basic Attachment Tutorial
Basic modeling tutorial
Basic Part Design Tutorial
Basic Part Design Tutorial 019
Basic Sketcher Tutorial
Basic TechDraw Tutorial
BIM application compatibility table
BIM Beam
BIM Box
BIM Classification
BIM Clone
BIM Column
BIM Copy
BIM DimensionAligned
BIM DimensionHorizontal
BIM DimensionVertical
BIM Door
BIM IfcElements
BIM IfcExplorer
BIM IfcProperties
BIM IfcQuantities
BIM ingame tutorial
BIM Layers
BIM Leader
BIM Library
BIM Preferences
BIM Preflight
BIM ProjectManager
BIM Setup
BIM Shape2DView
BIM Sketch
BIM Slab
BIM TDPage
BIM TDView
BIM Text
BIM Views
BIM Windows
BIM Workbench
Bitmap
Body
BOLTSFC Workbench
Books
Branding
Builtin modules
CadQuery Workbench
CAM Adaptive
CAM Area
CAM Area Workplane
CAM Array
CAM Comment
CAM Copy
CAM Custom
CAM Deburr
CAM DressupAxisMap
CAM DressupDogbone
CAM DressupDragKnife
CAM DressupLeadInOut
CAM DressupPathBoundary
CAM DressupRampEntry
CAM DressupTag
CAM DressupZCorrect
CAM Drilling
CAM Engrave
CAM experimental
CAM ExportTemplate
CAM FAQ
CAM Fixture
CAM fourth axis
CAM Helix
CAM Inspect
CAM Job
CAM MillFace
CAM OpActiveToggle
CAM Pocket 3D
CAM Pocket Shape
CAM Post
CAM Postprocessor Customization
CAM Preferences
CAM Probe
CAM Profile
CAM Sanity
CAM scripting
CAM SelectLoop
CAM SetupSheet
CAM Shape
CAM SimpleCopy
CAM Simulator
CAM Slot
CAM Stop
CAM Surface
CAM ThreadMilling
CAM ToolBit
CAM ToolBit Library
CAM ToolBitDock
CAM ToolBitLibraryOpen
CAM ToolController
CAM Tools
CAM ToolShape
CAM Vcarve
CAM Walkthrough for the Impatient
CAM Waterline
CAM Workbench
Cfd Workbench
Changelog
Civil Engineering Workbench
Code snippets
Coin3d snippets
Combo view
Command
Common Airfoil Data Import
Compile on Docker
Compile on Linux
Compile on MacOS
Compile on MinGW
Compile on Windows
CompileOnWindows - Reducing Disk Footprint
Compiling
Compiling (Speeding up)
Conda
Console API
Constructive solid geometry
Continuous Integration
Contributors
Copying Objects
Create a FeaturePython object part I
Create a FeaturePython object part II
Creating a simple part with Draft and Part WB
Creating a simple part with Part WB
Creating a simple part with PartDesign
Crowdin Administration
Crowdin Scripts
CurvedShapes CurvedArray
CurvedShapes Workbench
Curves CompressionSpring
Curves Discretize
Curves EditableSpline
Curves ExtendCurve
Curves GordonSurface
Curves Interpolate
Curves IsoCurve
Curves JoinCurve
Curves Line
Curves MultiLoft
Curves ParametricComb
Curves ParametricSolid
Curves PasteSVG
Curves Pipeshell
Curves PipeshellProfile
Curves ProfileSupport
Curves ReflectLines
Curves SegmentSurface
Curves SketchOnSurface
Curves SplitCurve
Curves ToConsole
Curves Workbench
Curves ZebraTool
Custom icon in tree view
Customize Toolbars
DAG view
Datum
Debian development
Debian Unstable
Debugging
Defeaturing
Defeaturing Workbench
Developer hub
Developing FreeCAD with GitKraken
Developing FreeCAD with KDevelop
Development roadmap
Dialog creation
Dialog creation image and animated GIF
Dialog creation reading and writing files
Dialog creation setting colors
Dialog creation with various widgets
Document structure
Donate
Download
Doxygen
Draft AddConstruction
Draft AddNamedGroup
Draft AddToGroup
Draft annotation scale widget
Draft AnnotationStyleEditor
Draft API
Draft ApplyStyle
Draft Arc
Draft Arc 3Points
Draft Array
Draft AutoGroup
Draft BezCurve
Draft BSpline
Draft Circle
Draft CircularArray
Draft Clone
Draft Constrain
Draft CubicBezCurve
Draft DAT
Draft Dimension
Draft Downgrade
Draft Draft2Sketch
Draft Drawing
Draft DXF
Draft Edit
Draft Ellipse
Draft Facebinder
Draft Fillet
Draft FlipDimension
Draft Hatch
Draft Heal
Draft Join
Draft Label
Draft Layer
Draft LayerManager
Draft Line
Draft Mirror
Draft Move
Draft OCA
Draft Offset
Draft OrthoArray
Draft PathArray
Draft PathLinkArray
Draft Pattern
Draft Point
Draft PointArray
Draft PointLinkArray
Draft PolarArray
Draft Polygon
Draft Preferences
Draft Rectangle
Draft Rotate
Draft Scale
Draft SelectGroup
Draft SelectPlane
Draft SetStyle
Draft Shape2DView
Draft ShapeString
Draft ShapeString tutorial
Draft ShowSnapBar
Draft Slope
Draft Snap
Draft Snap Angle
Draft Snap Center
Draft Snap Dimensions
Draft Snap Endpoint
Draft Snap Extension
Draft Snap Grid
Draft Snap Intersection
Draft Snap Lock
Draft Snap Midpoint
Draft Snap Near
Draft Snap Ortho
Draft Snap Parallel
Draft Snap Perpendicular
Draft Snap Special
Draft snap widget
Draft Snap WorkingPlane
Draft Split
Draft Stretch
Draft SubelementHighlight
Draft SVG
Draft Text
Draft ToggleConstructionMode
Draft ToggleContinueMode
Draft ToggleDisplayMode
Draft ToggleGrid
Draft Tray
Draft Trimex
Draft tutorial
Draft Upgrade
Draft Wire
Draft WireToBSpline
Draft Workbench
Draft WorkingPlaneProxy
Drawing
Drawing Annotation
Drawing API example
Drawing Clip
Drawing Dimensioning Addon
Drawing Documentation
Drawing Landscape A3
Drawing Open SVG
Drawing Openbrowser
Drawing Orthoviews
Drawing ProjectShape
Drawing Save
Drawing SpreadsheetView
Drawing Symbol
Drawing Template HowTo
Drawing templates
Drawing tutorial
Drawing View
Drawing Workbench
DXF
DynamicData Workbench
EM FHEquiv
EM FHInputFile
EM FHNode
EM FHPath
EM FHPlane
EM FHPlaneAddRemoveNodeHole
EM FHPlaneHole
EM FHPort
EM FHSegment
EM FHSolver
EM Workbench
Embedding FreeCAD
Embedding FreeCADGui
Engine Block Tutorial
Example Combined Footing
Example Slab Having LShape Rebars Reinforcement Mesh
Example Slab Having Mesh Of Straight Rebars
Example Slab Having UShape Rebars Reinforcement Mesh
Example Slab Spanning in One Direction
Example Slab Spanning in Two Directions
ExplodedAssembly Workbench
Export to STL or OBJ
Expressions
Extend FEM Module
External workbenches
Extra python modules
Fasteners BOM
Fasteners ChamferHole
Fasteners ChangeParameters
Fasteners Flip
Fasteners MatchTypeInner
Fasteners MatchTypeOuter
Fasteners Move
Fasteners ScrewCalculator
Fasteners Simplify
Fasteners Workbench
FCGear BevelGear
FCGear CrownGear
FCGear CycloidGear
FCGear CycloidRack
FCGear GearConnector
FCGear HypoCycloidGear
FCGear InternalInvoluteGear
FCGear InvoluteGear
FCGear InvoluteRack
FCGear LanternGear
FCGear TimingGear
FCGear Workbench
FCGear WormGear
Fcmcua Workbench
Feature
Feature editing
Feature list
FeaturePython Custom Properties
FeaturePython methods
FEM Analysis
FEM CalculiX
FEM CalculiX Cantilever 3D
FEM ClippingPlaneAdd
FEM ClippingPlaneRemoveAll
FEM Concrete
FEM ConstantVacuumPermittivity
FEM ConstraintBearing
FEM ConstraintBodyHeatSource
FEM ConstraintCentrif
FEM ConstraintContact
FEM ConstraintCurrentDensity
FEM ConstraintDisplacement
FEM ConstraintElectrostaticPotential
FEM ConstraintFixed
FEM ConstraintFlowVelocity
FEM ConstraintFluidBoundary
FEM ConstraintForce
FEM ConstraintGear
FEM ConstraintHeatflux
FEM ConstraintInitialFlowVelocity
FEM ConstraintInitialPressure
FEM ConstraintInitialTemperature
FEM ConstraintMagnetization
FEM ConstraintPlaneRotation
FEM ConstraintPressure
FEM ConstraintPulley
FEM ConstraintRigidBody
FEM ConstraintSectionPrint
FEM ConstraintSelfWeight
FEM ConstraintSpring
FEM ConstraintTemperature
FEM ConstraintTie
FEM ConstraintTransform
FEM CreateNodesSet
FEM Element Types
FEM ElementFluid1D
FEM ElementGeometry1D
FEM ElementGeometry2D
FEM ElementRotation1D
FEM EquationDeformation
FEM EquationElasticity
FEM EquationElectricforce
FEM EquationElectrostatic
FEM EquationFlow
FEM EquationFlux
FEM EquationHeat
FEM EquationMagnetodynamic
FEM EquationMagnetodynamic2D
FEM Example Capacitance Two Balls
FEM Examples
FEM FemMesh2Mesh
FEM FrontISTR Workbench
FEM Geometry Preparation and Meshing
FEM Install
FEM MaterialEditor
FEM MaterialFluid
FEM MaterialMechanicalNonlinear
FEM MaterialReinforced
FEM MaterialSolid
FEM Mesh
FEM Mesh CalculiX
FEM MeshBoundaryLayer
FEM MeshClear
FEM MeshDisplayInfo
FEM MeshGmshFromShape
FEM MeshGroup
FEM MeshNetgenFromShape
FEM MeshRegion
FEM PostApplyChanges
FEM PostCreateFunctionBox
FEM PostCreateFunctionCylinder
FEM PostCreateFunctionPlane
FEM PostCreateFunctionSphere
FEM PostFilterClipRegion
FEM PostFilterClipScalar
FEM PostFilterContours
FEM PostFilterCutFunction
FEM PostFilterDataAlongLine
FEM PostFilterDataAtPoint
FEM PostFilterLinearizedStresses
FEM PostFilterWarp
FEM PostPipelineFromResult
FEM Preferences
FEM ResultShow
FEM ResultsPurge
FEM Shear of a Composite Block
FEM Solver
FEM SolverCalculiX
FEM SolverCalculixCxxtools
FEM SolverControl
FEM SolverElmer
FEM SolverElmer SolverSettings
FEM SolverMystran
FEM SolverRun
FEM SolverZ88
FEM tutorial
FEM Tutorial Python
FEM Workbench
FEMbyGEN Workbench
File Format FCStd
Fine-tuning
Flamingo Workbench
Flatpak
FreeCAD and DWG Import
FreeCAD and DXF Import
FreeCAD and Mesh Import
FreeCAD API
FreeCAD Build Tool
FreeCAD Community Portal
FreeCAD Docker CLI mode
FreeCAD Managing Expectations
FreeCAD Scripting Basics
FreeCAD used in production
FreeCAD vector math library
FreeCAD-SH3D
FreeCAD-Ship s60 tutorial
FreeCAD-Ship s60 tutorial (II)
FreeCADGui API
Frequently asked questions
Getting started
Git buildpackage
Glossary
GlTF
Gui Command
GuiCommand model
Headless FreeCAD
Help
Help FreeCAD
History
How to install additional workbenches
How to install macros
IfcOpenShell
IfcPlusPlus
Image CreateImagePlane
Image Open
Image Scaling
Image Workbench
Import Export
Import Export Preferences
Import from STL or OBJ
Import OpenSCAD code
Import text and geometry from Inkscape
Import/Export IFC - compiling IfcOpenShell
Important information
Importing From Sketchup
InputField
Inspection Workbench
Installing additional components
Installing Helpfile
Installing more workbenches
Installing on Linux
Installing on Mac
Installing on Windows
Interface
Interface creation
Interface Customization
Introduction to Python
Key ASCII
KicadStepUp Workbench
Lattice2 AttachablePlacement
Lattice2 Workbench
LGTM
License
Line drawing function
LinkSub
LinkSubList
Linux packaging
Localisation
Localisation Sidebar
Localization Older Methods
LuxCoreRender
LuxRender
MacOS packaging
Macro 3D Parametric Curve
Macro 3d Printer Slicer
Macro 3d Printer Slicer Individual Parts
Macro 3D Printer Workflow
Macro 3DXML import
Macro AeroFoil
Macro Airfoil Import & Scale
Macro Alias For Table For Object
Macro Align Camera to Working Plane
Macro Align Face Object to View
Macro Align Object to View
Macro Align View to Face
Macro Align Working Plane to Camera
Macro Animated Constrain
Macro Animator
Macro Apothem Based Prism GUI
Macro Arch Axis System Repartition
Macro ArrayCopy
Macro Assemblage Imprimante 3D
Macro Assembly
Macro at Startup
Macro Automatic drawing
Macro Bevel
Macro BOLTS
Macro BoundingBox Tracing
Macro BSurf from grid
Macro Build Utility
Macro Cabinets32
Macro CartoucheFC
Macro CartoucheFC 2
Macro CartoucheFC Full
Macro Center Align Objects with Faces or Edges
Macro CenterFace
Macro CenterOfMass
Macro Circle
Macro CirclePlus
Macro clone explicit
Macro CloneConvert
Macro Colorize
Macro Compound Plus
Macro Connect And Sweep
Macro Constraint Draft
Macro ConstraintToAlias
Macro Convert 021
Macro Copy3DViewToClipboard
Macro Corner shapes wizard
Macro Corner shapes wizard/update
Macro crank simul
Macro Creating faces from a DXF file
Macro cross section
Macro Cut Circle
Macro Cut Line
Macro DeepCopy
Macro Delta xyz
Macro documentation
Macro Draft Circle 3 Points
Macro Draft Circle 3 Points 3D
Macro Draft Circle Tangent
Macro Draw 2D Function
Macro Draw Parametric 2D Function
Macro Dump Objects
Macro Duplicate Selection
Macro DXF to Face and Sketch
Macro Easy cutouts for Enclosure Design
Macro EasyAlias
Macro EasyReflector
Macro EdgesToArc
Macro Editor Assistant
Macro Ellipse-Center+2Points
Macro ExpandTreeItem
Macro export transient FEM results
Macro Extract Wires from Mesh
Macro FaceToSketch
Macro FC Convert Lines
Macro FC element selector
Macro FCBmpImport
Macro FCCamera
Macro FCCamGroover
Macro FCCircularText
Macro FCGear
Macro FCHoneycombMaker
Macro FCInfo
Macro FCInfo Alternate Linux
Macro FCInfo ToolBar
Macro FCInfoGlass
Macro FCInfoToMouse
Macro FCSpreadSheet Extract
Macro FCSpring Helix Variable
Macro FCSpring On Surface
Macro FCTreeView
Macro FCWire To Volume
Macro FindAliasReferences
Macro findConfigFiles
Macro FlattenWire
Macro FlattenWire3Points
Macro Fonts Win10 PYMP
Macro ForceRecompute
Macro FreeCAD to Kerkythea
Macro GenerateDrawing
Macro GenerateViews
Macro Geneva Wheel
Macro Geneva Wheel GUI
Macro Geodesic Dome
Macro Global Variable Watcher
Macro GMSH
Macro GuiResetToolbars
Macro Guitar fretboard
Macro Guitar Nut
Macro Half turn stairs
Macro Half-Hull Model
Macro HealArcs
Macro HiddenAlls
Macro HighlightCommon
Macro HighlightDifference
Macro HilbertCurve
Macro hinge
Macro Honeycomb
Macro If Selected Stay If Not Then Delete
Macro Iges PyImporter
Macro Image Scaling
Macro ImperialScales
Macro ImportAirfoil
Macro Intersection
Macro Joint
Macro JointWire
Macro Kerkythea
Macro Line Length
Macro Loft
Macro MacroMenu
Macro MacroToolbarManager
Macro Make Arc 3 Points
Macro Make Circle 3 Points
Macro Make Cube
Macro MatrixTransform
Macro MeasureCircle
Macro Megaminx
Macro merge duplicate materials
Macro MeshToPart
Macro MessageBox
Macro Mouse Cross
Macro Mouse over cb
Macro MoveToOrigin
Macro MultiCopy
Macro MultiCuts
Macro Normal Vector
Macro ObjectInfo
Macro Overlap
Macro Parametric Curve FP
Macro Parametric Defeaturing
Macro PartsLibrary
Macro PartToVRML
Macro PCBWay
Macro PDWrapper
Macro Perpendicular To Wire
Macro Pinger
Macro Place Image
Macro PlacementAbsolufy
Macro Polyhedrons
Macro Print SceneGraph
Macro PropertyMemo
Macro Pyramid
Macro Python Assistant Window
Macro Recompute Profiler
Macro Rectellipse
Macro Remove parametric history
Macro Replace Part in Assembly
Macro Repro Wire
Macro Rotate To Point
Macro Rotate View
Macro Rotate View Free
Macro Rotate ViewAxonometric
Macro Rubik Cube
Macro Screen Wiki
Macro screw maker1 2
Macro Section
Macro Select Hovering
Macro SelectVisible
Macro Shake Sketch
Macro Sheet Metal Unfolder
Macro SimpleProperties
Macro Site From Contours
Macro Sketch Constraint From Spreadsheet
Macro SketchUnmap
Macro Snip
Macro Solid Sweep
Macro SplitPropEditor
Macro Spreadsheet2html
Macro SpreadsheetTools
Macro Spring
Macro Stairs
Macro StraightenObject
Macro SuperWire
Macro TemplateHelper
Macro Texture
Macro Texture Objects
Macro TimingGear
Macro TNP Solution
Macro Toggle Drawstyle
Macro Toggle Drawstyle Optimized
Macro Toggle Panels Visibility
Macro Toggle Visibility
Macro Toggle Visibility2 1-2
Macro Toggle Visibility2 2-2
Macro TreeToAscii
Macro Triangle AH
Macro Unbind Numpad Shortcuts
Macro Unfold Box
Macro Unroll Ruled Surface
Macro View Rotation
Macro Visibility Manager
Macro VisibleAlls
Macro Wiki Object Properties List Generator
Macro Wiki Object Properties List Generator Basic Version
Macro WireFilter
Macro WireXYZ
Macro Wiring And Hoses
Macro WorkFeatures
Macro Z Height Map
Macro Zoom1 1
Macros
Macros recipes
Main Page
Main view area
Manipulator Workbench
Manual:A gentle introduction
Manual:All workbenches at a glance
Manual:BIM modeling
Manual:Creating and manipulating geometry
Manual:Creating FEM analyses
Manual:Creating interface tools
Manual:Creating parametric objects
Manual:Creating renderings
Manual:Generating 2D drawings
Manual:Import and export to other filetypes
Manual:Installing
Manual:Introduction
Manual:Modeling for product design
Manual:Navigating in the 3D view
Manual:Parametric objects
Manual:Preparing models for 3D printing
Manual:Summary
Manual:The Community
Manual:The FreeCAD document
Manual:The FreeCAD Interface
Manual:Traditional 2D drafting
Manual:Traditional modeling, the CSG way
Manual:Using spreadsheets
Manual:What is FreeCAD
Material Workbench
Matrix API
Measurement Of Angles On Holes
Mesh
Mesh AddFacet
Mesh API
Mesh BoundingBox
Mesh BuildRegularSolid
Mesh CrossSections
Mesh CurvatureInfo
Mesh Decimating
Mesh Difference
Mesh EvaluateFacet
Mesh EvaluateSolid
Mesh Evaluation
Mesh Export
Mesh Feature
Mesh FillInteractiveHole
Mesh FillupHoles
Mesh FlipNormals
Mesh FromPartShape
Mesh HarmonizeNormals
Mesh Import
Mesh Intersection
Mesh Merge
Mesh MeshObject
Mesh PolyCut
Mesh PolyTrim
Mesh RemeshGmsh
Mesh RemoveCompByHand
Mesh RemoveComponents
Mesh Scale
Mesh Scripting
Mesh SectionByPlane
Mesh Segmentation
Mesh SegmentationBestFit
Mesh Smoothing
Mesh SplitComponents
Mesh to Part
Mesh TrimByPlane
Mesh Union
Mesh VertexCurvature
Mesh Workbench
MeshPart CreateFlatFace
MeshPart CreateFlatMesh
MeshRemodel Workbench
MIBA
Migrating to FreeCAD from Fusion360
Migrating to FreeCAD from OnShape
Migrating to FreeCAD from Revit
Migrating to FreeCAD from SolidWorks
Misc templates
Misc templates Full
Model
ModernUI Workbench
MOOC Workbench
Mouse navigation
Multithreading
Navigation Cube
NumPy
O-X-Y Type Attachment Modes
Object API
Object name
Onboarding FEM Devs
Online Help Startpage
Online Help Toc
OpenCamLib
OpenCASCADE
OpenSCAD AddOpenSCADElement
OpenSCAD ColorCodeShape
OpenSCAD CSG
OpenSCAD Edgestofaces
OpenSCAD ExpandPlacements
OpenSCAD ExplodeGroup
OpenSCAD Hull
OpenSCAD IncreaseToleranceFeature
OpenSCAD MeshBoolean
OpenSCAD Minkowski
OpenSCAD MirrorMeshFeature
OpenSCAD Preferences
OpenSCAD RefineShapeFeature
OpenSCAD RemoveSubtree
OpenSCAD ReplaceObject
OpenSCAD ResizeMeshFeature
OpenSCAD ScaleMeshFeature
OpenSCAD Workbench
Organization chart
OSE 3D Printer Workbench
OSE Piping Workbench
Package Metadata
Packaging
Part
Part and PartDesign
Part API
Part Boolean
Part BooleanFragments
Part Box
Part BoxSelection
Part Builder
Part Chamfer
Part CheckGeometry
Part Circle
Part ColorPerFace
Part Common
Part CompCompoundTools
Part CompJoinFeatures
Part CompOffsetTools
Part Compound
Part CompoundFilter
Part CompSplittingTools
Part Cone
Part CrossSections
Part Cut
Part Cylinder
Part Defeaturing
Part EditAttachment
Part ElementCopy
Part Ellipse
Part Ellipsoid
Part ExplodeCompound
Part Export
Part Extrude
Part Feature
Part Fillet
Part Fuse
Part Helix
Part Import
Part JoinConnect
Part JoinCutout
Part JoinEmbed
Part Line
Part Loft
Part Loft Technical Details
Part MakeFace
Part MakeSolid
Part Measure Angular
Part Measure Clear All
Part Measure Linear
Part Measure Refresh
Part Measure Toggle 3D
Part Measure Toggle All
Part Measure Toggle Delta
Part Mirror
Part Offset
Part Offset2D
Part Part2DObject
Part Plane
Part Point
Part PointsFromMesh
Part Primitives
Part Prism
Part ProjectionOnSurface
Part RefineShape
Part RegularPolygon
Part ReverseShape
Part Revolve
Part RuledSurface
Part Scale
Part scripting
Part Section
Part SectionCut
Part ShapeFromMesh
Part SimpleCopy
Part Slice
Part SliceApart
Part Sphere
Part Spiral
Part Sweep
Part Thickness
Part TopoShape
Part Torus
Part TransformedCopy
Part Tube
Part Wedge
Part Workbench
Part XOR
PartDesign AdditiveBox
PartDesign AdditiveCone
PartDesign AdditiveCylinder
PartDesign AdditiveEllipsoid
PartDesign AdditiveHelix
PartDesign AdditiveLoft
PartDesign AdditivePipe
PartDesign AdditivePrism
PartDesign AdditiveSphere
PartDesign AdditiveTorus
PartDesign AdditiveWedge
PartDesign Bearingholder Tutorial I
PartDesign Bearingholder Tutorial II
PartDesign Body
PartDesign Boolean
PartDesign Chamfer
PartDesign Clone
PartDesign CoordinateSystem
PartDesign Draft
PartDesign Examples
PartDesign Feature
PartDesign Fillet
PartDesign Groove
PartDesign Hole
PartDesign InvoluteGear
PartDesign Line
PartDesign LinearPattern
PartDesign Migrate
PartDesign Mirrored
PartDesign MoveFeature
PartDesign MoveFeatureInTree
PartDesign MoveTip
PartDesign MultiTransform
PartDesign NewSketch
PartDesign Pad
PartDesign Plane
PartDesign Pocket
PartDesign Point
PartDesign PolarPattern
PartDesign Preferences
PartDesign Revolution
PartDesign Scaled
PartDesign ShapeBinder
PartDesign Sprocket
PartDesign SubShapeBinder
PartDesign SubtractiveBox
PartDesign SubtractiveCone
PartDesign SubtractiveCylinder
PartDesign SubtractiveEllipsoid
PartDesign SubtractiveHelix
PartDesign SubtractiveLoft
PartDesign SubtractivePipe
PartDesign SubtractivePrism
PartDesign SubtractiveSphere
PartDesign SubtractiveTorus
PartDesign SubtractiveWedge
PartDesign Thickness
PartDesign tutorial
PartDesign WizardShaft
PartDesign Workbench
Parts Library Workbench
PCB Workbench
PDF
Pivy
Placement
Placement API
Plot Axes
Plot Basic tutorial
Plot Grid
Plot Labels
Plot Legend
Plot MultiAxes tutorial
Plot Positions
Plot Save
Plot Series
Plot Workbench
Points Convert
Points Export
Points Import
Points Merge
Points PolyCut
Points Structure
Points Workbench
Post-Processing of FEM Results with Paraview
POV-Ray
POV-Ray-Rendering Workbench
Power users hub
Preference Packs
Preferences Editor
Private Preference Packs
Profiling
Property
Property editor
PropertyLink: InList and OutList
Pyramids and polyhedrons Workbench
Pyrate Workbench
PySide
PySide Advanced Examples
PySide Beginner Examples
PySide Intermediate Examples
PySide usage snippets
Python
Python console
Python Development Environment
Python scripting tutorial
PythonOCC
Qt Example
Quantity
Raytracing API example
Raytracing ExportProject
Raytracing InsertPart
Raytracing Lux
Raytracing New
Raytracing Preferences
Raytracing Render
Raytracing ResetCamera
Raytracing templates
Raytracing tutorial
Raytracing Workbench
Raytracing WriteCamera
Raytracing WritePart
Raytracing WriteView
Reinforcement API
Reinforcement BarBendingSchedule
Reinforcement BarShapeCutList
Reinforcement BeamRebars
Reinforcement BentShapeRebar
Reinforcement BillOfMaterial
Reinforcement ColumnRebars
Reinforcement ColumnRebars Circular
Reinforcement ColumnRebars TwoTiesSixRebars
Reinforcement Custom Spacing
Reinforcement DrawingDimensioning
Reinforcement FootingRebars
Reinforcement HelicalRebar
Reinforcement LShapeRebar
Reinforcement SlabRebars
Reinforcement StirrupRebar
Reinforcement StraightRebar
Reinforcement UShapeRebar
Reinforcement Workbench
Release notes 0.13
Release notes 0.14
Release notes 0.15
Release notes 0.16
Release notes 0.17
Release notes 0.18
Release notes 0.19
Release notes 0.20
Release notes 0.21
Release notes 1.0
Render Workbench
Report view
Reverse Engineering Workbench
Robot 6-Axis
Robot API example
Robot CreateRobot
Robot CreateTrajectory
Robot Edge2Trac
Robot Export
Robot InsertWaypoint
Robot InsertWaypointPre
Robot RestoreHomePos
Robot SetDefaultOrientation
Robot SetDefaultValues
Robot SetHomePos
Robot Simulate
Robot TrajectoryCompound
Robot TrajectoryDressUp
Robot tutorial
Robot Workbench
Rocket BodyTube
Rocket Bulkhead
Rocket CenteringRing
Rocket CompLaunchGuide
Rocket Ejection Charge Calculator
Rocket Fin
Rocket FinCan
Rocket LaunchLug
Rocket NoseCone
Rocket Parachute Size Calculator
Rocket RailButton
Rocket RailGuide
Rocket Thrust To Weight Calculator
Rocket Transition
Rocket Vent Hole Size Calculator
Rocket Workbench
Scenegraph
Scientific literature
Screenshots
Scripted objects
Scripted objects migration
Scripted objects saving attributes
Scripted objects with attachment
Scripted Parts: Ball Bearing - Part 1
Scripted Parts: Ball Bearing - Part 2
Scripting and macros
Scripts
SearchBar Mod
Selection API
Selection methods
Selection view
Shape
SheetMetal AddBase
SheetMetal AddBend
SheetMetal AddCornerRelief
SheetMetal AddFoldWall
SheetMetal AddJunction
SheetMetal AddRelief
SheetMetal AddWall
SheetMetal BaseShape
SheetMetal Examples
SheetMetal Extrude
SheetMetal Forming
SheetMetal SketchOnSheet
SheetMetal UnattendedUnfold
SheetMetal Unfold
SheetMetal Workbench
Ship AreasCurve
Ship Capacity
Ship CreateShip
Ship GZ
Ship Hydrostatics
Ship LoadCondition
Ship LoadExample
Ship Tank
Ship Weight
Ship Workbench
Silk Workbench
Sketch
Sketcher ArcOverlay
Sketcher BSplineComb
Sketcher BSplineConvertToNURBS
Sketcher BSplineDecreaseDegree
Sketcher BSplineDecreaseKnotMultiplicity
Sketcher BSplineDegree
Sketcher BSplineIncreaseDegree
Sketcher BSplineIncreaseKnotMultiplicity
Sketcher BSplineInsertKnot
Sketcher BSplineKnotMultiplicity
Sketcher BSplinePoleWeight
Sketcher BSplinePolygon
Sketcher CarbonCopy
Sketcher Clone
Sketcher CloseShape
Sketcher ConnectLines
Sketcher ConstrainAngle
Sketcher ConstrainBlock
Sketcher ConstrainCoincident
Sketcher ConstrainCoincidentUnified
Sketcher ConstrainDiameter
Sketcher ConstrainDistance
Sketcher ConstrainDistanceX
Sketcher ConstrainDistanceY
Sketcher ConstrainEqual
Sketcher ConstrainHorizontal
Sketcher ConstrainHorVer
Sketcher ConstrainLock
Sketcher ConstrainParallel
Sketcher ConstrainPerpendicular
Sketcher ConstrainPointOnObject
Sketcher ConstrainRadiam
Sketcher ConstrainRadius
Sketcher ConstrainSnellsLaw
Sketcher ConstrainSymmetric
Sketcher ConstrainTangent
Sketcher ConstrainVertical
Sketcher Copy
Sketcher Create3PointArc
Sketcher Create3PointCircle
Sketcher CreateArc
Sketcher CreateArcOfEllipse
Sketcher CreateArcOfHyperbola
Sketcher CreateArcOfParabola
Sketcher CreateArcSlot
Sketcher CreateBSpline
Sketcher CreateBSplineByInterpolation
Sketcher CreateChamfer
Sketcher CreateCircle
Sketcher CreateEllipseBy3Points
Sketcher CreateEllipseByCenter
Sketcher CreateFillet
Sketcher CreateHeptagon
Sketcher CreateHexagon
Sketcher CreateLine
Sketcher CreateOblong
Sketcher CreateOctagon
Sketcher CreatePentagon
Sketcher CreatePeriodicBSpline
Sketcher CreatePeriodicBSplineByInterpolation
Sketcher CreatePoint
Sketcher CreatePointFillet
Sketcher CreatePolyline
Sketcher CreateRectangle
Sketcher CreateRectangle Center
Sketcher CreateRegularPolygon
Sketcher CreateSlot
Sketcher CreateSquare
Sketcher CreateTriangle
Sketcher DeleteAllConstraints
Sketcher DeleteAllGeometry
Sketcher Dialog
Sketcher Dimension
Sketcher EditSketch
Sketcher Examples
Sketcher Extend
Sketcher External
Sketcher Grid
Sketcher helper constraint
Sketcher JoinCurves
Sketcher LeaveSketch
Sketcher MapSketch
Sketcher MergeSketches
Sketcher Micro Tutorial - Constraint Practices
Sketcher MirrorSketch
Sketcher Move
Sketcher NewSketch
Sketcher Offset
Sketcher Preferences
Sketcher RectangularArray
Sketcher reference
Sketcher RemoveAxesAlignment
Sketcher RenderingOrder
Sketcher ReorientSketch
Sketcher requirement for a sketch
Sketcher RestoreInternalAlignmentGeometry
Sketcher Rotate
Sketcher Scale
Sketcher scripting
Sketcher SelectConflictingConstraints
Sketcher SelectConstraints
Sketcher SelectElementsAssociatedWithConstraints
Sketcher SelectElementsWithDoFs
Sketcher SelectHorizontalAxis
Sketcher SelectOrigin
Sketcher SelectRedundantConstraints
Sketcher SelectVerticalAxis
Sketcher SketchObject
Sketcher Snap
Sketcher Split
Sketcher StopOperation
Sketcher SwitchVirtualSpace
Sketcher Symmetry
Sketcher ToggleActiveConstraint
Sketcher ToggleConstruction
Sketcher ToggleDrivingConstraint
Sketcher Translate
Sketcher Trimming
Sketcher Tutorial
Sketcher ValidateSketch
Sketcher ViewSection
Sketcher ViewSketch
Sketcher Workbench
Source code management
Source documentation
Sphinx
Splash screen
Spreadsheet
Spreadsheet AlignBottom
Spreadsheet AlignCenter
Spreadsheet AlignLeft
Spreadsheet AlignRight
Spreadsheet AlignTop
Spreadsheet AlignVCenter
Spreadsheet CreateSheet
Spreadsheet CSV
Spreadsheet Export
Spreadsheet Import
Spreadsheet MergeCells
Spreadsheet Preferences
Spreadsheet SetAlias
Spreadsheet SplitCell
Spreadsheet StyleBold
Spreadsheet StyleItalic
Spreadsheet StyleUnderline
Spreadsheet Workbench
Standard Menu
Start Preferences
Start up and Configuration
Start Workbench
Status bar
Std About
Std ActivateNextWindow
Std ActivatePrevWindow
Std AddonMgr
Std Alignment
Std AxisCross
Std Base
Std BoxElementSelection
Std BoxSelection
Std CascadeWindows
Std CloseActiveWindow
Std CloseAllWindows
Std Copy
Std Cut
Std Delete
Std DemoMode
Std DependencyGraph
Std DlgCustomize
Std DlgMacroExecute
Std DlgMacroExecuteDirect
Std DlgMacroRecord
Std DlgParameter
Std DlgPreferences
Std DrawStyle
Std DuplicateSelection
Std Edit
Std Edit Menu
Std Export
Std File Menu
Std FreeCADDonation
Std FreeCADFAQ
Std FreeCADForum
Std FreeCADPowerUserHub
Std FreeCADUserHub
Std FreeCADWebsite
Std FreezeViews
Std Group
Std Help Menu
Std HideObjects
Std HideSelection
Std Import
Std LinkImport
Std LinkImportAll
Std LinkMake
Std LinkMakeRelative
Std LinkReplace
Std LinkSelectAllLinks
Std LinkSelectLinked
Std LinkSelectLinkedFinal
Std LinkUnlink
Std Macro Menu
Std MacroAttachDebugger
Std MacroStartDebug
Std MacroStepInto
Std MacroStepOver
Std MacroStopDebug
Std MacroStopRecord
Std MainFullscreen
Std Measure
Std MeasureDistance
Std MergeProjects
Std New
Std OnlineHelp
Std Open
Std OrthographicCamera
Std Part
Std Paste
Std PerspectiveCamera
Std Placement
Std Print
Std PrintPdf
Std PrintPreview
Std ProjectInfo
Std ProjectUtil
Std PythonHelp
Std Quit
Std RandomColor
Std RecallWorkingView
Std RecentFiles
Std Redo
Std Refresh
Std ReportBug
Std Revert
Std Save
Std SaveAll
Std SaveAs
Std SaveCopy
Std SceneInspector
Std SelBack
Std SelBoundingBox
Std SelectAll
Std SelectVisibleObjects
Std SelForward
Std SendToPythonConsole
Std SetAppearance
Std ShowObjects
Std ShowSelection
Std StoreWorkingView
Std TextDocument
Std TextureMapping
Std TileWindows
Std ToggleBreakpoint
Std ToggleClipPlane
Std ToggleNavigation
Std ToggleObjects
Std ToggleSelectability
Std ToggleVisibility
Std Tools Menu
Std TransformManip
Std TreeCollapseDocument
Std TreeDrag
Std TreeMultiDocument
Std TreePreSelection
Std TreeRecordSelection
Std TreeSelection
Std TreeSingleDocument
Std TreeSyncPlacement
Std TreeSyncSelection
Std TreeSyncView
Std Undo
Std UnitsCalculator
Std UserEditMode
Std View Menu
Std ViewBottom
Std ViewBoxZoom
Std ViewCreate
Std ViewDimetric
Std ViewDockUndockFullscreen
Std ViewFitAll
Std ViewFitSelection
Std ViewFront
Std ViewFullscreen
Std ViewHome
Std ViewIsometric
Std ViewIvIssueCamPos
Std ViewIvStereoInterleavedColumns
Std ViewIvStereoInterleavedRows
Std ViewIvStereoOff
Std ViewIvStereoQuadBuff
Std ViewIvStereoRedGreen
Std ViewLeft
Std ViewLoadImage
Std ViewRear
Std ViewRight
Std ViewRotateLeft
Std ViewRotateRight
Std ViewScreenShot
Std ViewStatusBar
Std ViewTop
Std ViewTrimetric
Std ViewZoomIn
Std ViewZoomOut
Std WhatsThis
Std Windows
Std Windows Menu
Std Workbench
Stemfie Workbench
Surface BlendCurve
Surface CurveOnMesh
Surface ExtendFace
Surface Filling
Surface GeomFillSurface
Surface Sections
Surface Workbench
SVG
Svg Namespace
Swag
Symbols Library Workbench
Task panel
Tasks Placement
TechDraw 2LineCenterLine
TechDraw 2PointCenterLine
TechDraw 2PointCosmeticLine
TechDraw 3PtAngleDimension
TechDraw ActiveView
TechDraw AngleDimension
TechDraw Annotation
TechDraw API
TechDraw ArchView
TechDraw AxoLengthDimension
TechDraw Balloon
TechDraw BrokenView
TechDraw ClipGroup
TechDraw ClipGroupAdd
TechDraw ClipGroupRemove
TechDraw CommandAddOffsetVertex
TechDraw ComplexSection
TechDraw CosmeticCircle
TechDraw CosmeticEraser
TechDraw CosmeticVertex
TechDraw DecorateLine
TechDraw DetailView
TechDraw DiameterDimension
TechDraw DimensionRepair
TechDraw DraftView
TechDraw ExportPageDXF
TechDraw ExportPageSVG
TechDraw ExtensionArcLengthAnnotation
TechDraw ExtensionAreaAnnotation
TechDraw ExtensionCascadeHorizDimension
TechDraw ExtensionCascadeObliqueDimension
TechDraw ExtensionCascadeVertDimension
TechDraw ExtensionChangeLineAttributes
TechDraw ExtensionCircleCenterLines
TechDraw ExtensionCreateHorizChainDimension
TechDraw ExtensionCreateHorizChamferDimension
TechDraw ExtensionCreateHorizCoordDimension
TechDraw ExtensionCreateLengthArc
TechDraw ExtensionCreateObliqueChainDimension
TechDraw ExtensionCreateObliqueCoordDimension
TechDraw ExtensionCreateVertChainDimension
TechDraw ExtensionCreateVertChamferDimension
TechDraw ExtensionCreateVertCoordDimension
TechDraw ExtensionCustomizeFormat
TechDraw ExtensionDecreaseDecimal
TechDraw ExtensionDrawCosmArc
TechDraw ExtensionDrawCosmCircle
TechDraw ExtensionDrawCosmCircle3Points
TechDraw ExtensionExtendLine
TechDraw ExtensionHoleCircle
TechDraw ExtensionIncreaseDecimal
TechDraw ExtensionInsertDiameter
TechDraw ExtensionInsertSquare
TechDraw ExtensionLineParallel
TechDraw ExtensionLinePerpendicular
TechDraw ExtensionLockUnlockView
TechDraw ExtensionPosHorizChainDimension
TechDraw ExtensionPositionSectionView
TechDraw ExtensionPosObliqueChainDimension
TechDraw ExtensionPosVertChainDimension
TechDraw ExtensionRemovePrefixChar
TechDraw ExtensionSelectLineAttributes
TechDraw ExtensionShortenLine
TechDraw ExtensionThreadBoltBottom
TechDraw ExtensionThreadBoltSide
TechDraw ExtensionThreadHoleBottom
TechDraw ExtensionThreadHoleSide
TechDraw ExtensionVertexAtIntersection
TechDraw FaceCenterLine
TechDraw FillTemplateFields
TechDraw General Examples
TechDraw Geometric dimensioning and tolerancing
TechDraw GeometricHatch
TechDraw Hatch
TechDraw Hatching
TechDraw HoleShaftFit
TechDraw HorizontalDimension
TechDraw HorizontalExtentDimension
TechDraw HowTo Page
TechDraw Image
TechDraw LandmarkDimension
TechDraw LeaderLine
TechDraw LengthDimension
TechDraw LineGroup
TechDraw LinkDimension
TechDraw Midpoints
TechDraw MoveView
TechDraw PageDefault
TechDraw PageTemplate
TechDraw Pitch Circle Tutorial
TechDraw Preferences
TechDraw PrintAll
TechDraw ProjectionGroup
TechDraw ProjectShape
TechDraw Quadrants
TechDraw RadiusDimension
TechDraw RedrawPage
TechDraw RichTextAnnotation
TechDraw Section Examples
TechDraw SectionView
TechDraw ShareView
TechDraw ShowAll
TechDraw SpreadsheetView
TechDraw StackBottom
TechDraw StackDown
TechDraw StackTop
TechDraw StackUp
TechDraw SurfaceFinishSymbol
TechDraw Symbol
TechDraw TemplateGenerator
TechDraw TemplateHowTo
TechDraw Templates
TechDraw ToggleFrame
TechDraw VerticalDimension
TechDraw VerticalExtentDimension
TechDraw View
TechDraw WeldSymbol
TechDraw Workbench
TechDrawGui API
Testing
The FreeCAD source code
Third Party Libraries
Third Party Tools
Thread for Screw Tutorial
ThreadProfile Workbench
Timber Workbench
Toothbrush Head Stand
Topological data scripting
Topological naming problem
TopoShape API
Tracker
Transient FEM analysis
Translating an external workbench
Transportation Workbench
Tree view
Tutorial custom placing of windows and doors
Tutorial for open windows
Tutorial FreeCAD POV ray
Tutorial KinematicAssembly
Tutorial KinematicController
Tutorial KinematicSkeleton
Tutorial Render with Blender
Tutorials
Ubuntu Snap
Units
User hub
Vector API
Video tutorials
Video tutorials for architectural design
Video tutorials for product design
View Measure Clear All
View Measure Toggle All
ViewObject API
Viewprovider
VRML Preparation for Robot Simulation
Web BrowserBack
Web BrowserNext
Web BrowserRefresh
Web BrowserSetURL
Web BrowserStop
Web BrowserZoomIn
Web BrowserZoomOut
Web OpenWebsite
Web Workbench
WebTools BimServer
WebTools Git
WebTools Sketchfab
WebTools Workbench
Which workbench should I choose
Whiffle Ball tutorial
Wikihouse porting tutorial
WikiPages
WikiRobots
Windows packaging
Wood Frame Workbench
Workarounds
Workbench creation
Workbenches
Workfeature Workbench
Wrapping a Cplusplus class in Python
Language
aa - Qafár af
ab - аԥсшәа
abs - bahasa ambon
ace - Acèh
ady - адыгабзэ
ady-cyrl - адыгабзэ
aeb - تونسي / Tûnsî
aeb-arab - تونسي
aeb-latn - Tûnsî
af - Afrikaans
ak - Akan
aln - Gegë
alt - алтай тил
am - አማርኛ
ami - Pangcah
an - aragonés
ang - Ænglisc
ann - Obolo
anp - अंगिका
ar - العربية
arc - ܐܪܡܝܐ
arn - mapudungun
arq - جازايرية
ary - الدارجة
arz - مصرى
as - অসমীয়া
ase - American sign language
ast - asturianu
atj - Atikamekw
av - авар
avk - Kotava
awa - अवधी
ay - Aymar aru
az - azərbaycanca
azb - تۆرکجه
ba - башҡортса
ban - Basa Bali
ban-bali - ᬩᬲᬩᬮᬶ
bar - Boarisch
bbc - Batak Toba
bbc-latn - Batak Toba
bcc - جهلسری بلوچی
bci - wawle
bcl - Bikol Central
be - беларуская
be-tarask - беларуская (тарашкевіца)
bg - български
bgn - روچ کپتین بلوچی
bh - भोजपुरी
bho - भोजपुरी
bi - Bislama
bjn - Banjar
blk - ပအိုဝ်ႏဘာႏသာႏ
bm - bamanankan
bn - বাংলা
bo - བོད་ཡིག
bpy - বিষ্ণুপ্রিয়া মণিপুরী
bqi - بختیاری
br - brezhoneg
brh - Bráhuí
bs - bosanski
btm - Batak Mandailing
bto - Iriga Bicolano
bug - ᨅᨔ ᨕᨘᨁᨗ
bxr - буряад
ca - català
cbk-zam - Chavacano de Zamboanga
cdo - 閩東語 / Mìng-dĕ̤ng-ngṳ̄
ce - нохчийн
ceb - Cebuano
ch - Chamoru
cho - Chahta Anumpa
chr - ᏣᎳᎩ
chy - Tsetsêhestâhese
ckb - کوردی
co - corsu
cps - Capiceño
cr - Nēhiyawēwin / ᓀᐦᐃᔭᐍᐏᐣ
crh - qırımtatarca
crh-cyrl - къырымтатарджа (Кирилл)
crh-latn - qırımtatarca (Latin)
cs - čeština
csb - kaszëbsczi
cu - словѣньскъ / ⰔⰎⰑⰂⰡⰐⰠⰔⰍⰟ
cv - чӑвашла
cy - Cymraeg
da - dansk
dag - dagbanli
de - Deutsch
de-at - Österreichisches Deutsch
de-ch - Schweizer Hochdeutsch
de-formal - Deutsch (Sie-Form)
dga - Dagaare
din - Thuɔŋjäŋ
diq - Zazaki
dsb - dolnoserbski
dtp - Dusun Bundu-liwan
dty - डोटेली
dv - ދިވެހިބަސް
dz - ཇོང་ཁ
ee - eʋegbe
egl - Emiliàn
el - Ελληνικά
eml - emiliàn e rumagnòl
en - English
en-ca - Canadian English
en-gb - British English
eo - Esperanto
es - español
es-419 - español de América Latina
es-formal - español (formal)
et - eesti
eu - euskara
ext - estremeñu
fa - فارسی
fat - mfantse
ff - Fulfulde
fi - suomi
fit - meänkieli
fj - Na Vosa Vakaviti
fo - føroyskt
fon - fɔ̀ngbè
fr - français
frc - français cadien
frp - arpetan
frr - Nordfriisk
fur - furlan
fy - Frysk
ga - Gaeilge
gaa - Ga
gag - Gagauz
gan - 贛語
gan-hans - 赣语(简体)
gan-hant - 贛語(繁體)
gcr - kriyòl gwiyannen
gd - Gàidhlig
gl - galego
gld - на̄ни
glk - گیلکی
gn - Avañe'ẽ
gom - गोंयची कोंकणी / Gõychi Konknni
gom-deva - गोंयची कोंकणी
gom-latn - Gõychi Konknni
gor - Bahasa Hulontalo
got - 𐌲𐌿𐍄𐌹𐍃𐌺
gpe - Ghanaian Pidgin
grc - Ἀρχαία ἑλληνικὴ
gsw - Alemannisch
gu - ગુજરાતી
guc - wayuunaiki
gur - farefare
guw - gungbe
gv - Gaelg
ha - Hausa
hak - 客家語/Hak-kâ-ngî
haw - Hawaiʻi
he - עברית
hi - हिन्दी
hif - Fiji Hindi
hif-latn - Fiji Hindi
hil - Ilonggo
ho - Hiri Motu
hr - hrvatski
hrx - Hunsrik
hsb - hornjoserbsce
hsn - 湘语
ht - Kreyòl ayisyen
hu - magyar
hu-formal - magyar (formal)
hy - հայերեն
hyw - Արեւմտահայերէն
hz - Otsiherero
ia - interlingua
id - Bahasa Indonesia
ie - Interlingue
ig - Igbo
igl - Igala
ii - ꆇꉙ
ik - Iñupiatun
ike-cans - ᐃᓄᒃᑎᑐᑦ
ike-latn - inuktitut
ilo - Ilokano
inh - гӀалгӀай
io - Ido
is - íslenska
it - italiano
iu - ᐃᓄᒃᑎᑐᑦ / inuktitut
ja - 日本語
jam - Patois
jbo - la .lojban.
jut - jysk
jv - Jawa
ka - ქართული
kaa - Qaraqalpaqsha
kab - Taqbaylit
kbd - адыгэбзэ
kbd-cyrl - адыгэбзэ
kbp - Kabɩyɛ
kcg - Tyap
kea - kabuverdianu
kg - Kongo
khw - کھوار
ki - Gĩkũyũ
kiu - Kırmancki
kj - Kwanyama
kjh - хакас
kjp - ဖၠုံလိက်
kk - қазақша
kk-arab - قازاقشا (تٴوتە)
kk-cn - قازاقشا (جۇنگو)
kk-cyrl - қазақша (кирил)
kk-kz - қазақша (Қазақстан)
kk-latn - qazaqşa (latın)
kk-tr - qazaqşa (Türkïya)
kl - kalaallisut
km - ភាសាខ្មែរ
kn - ಕನ್ನಡ
ko - 한국어
ko-kp - 조선말
koi - перем коми
kr - kanuri
krc - къарачай-малкъар
kri - Krio
krj - Kinaray-a
krl - karjal
ks - कॉशुर / کٲشُر
ks-arab - کٲشُر
ks-deva - कॉशुर
ksh - Ripoarisch
ksw - စှီၤ
ku - kurdî
ku-arab - كوردي (عەرەبی)
ku-latn - kurdî (latînî)
kum - къумукъ
kus - Kʋsaal
kv - коми
kw - kernowek
ky - кыргызча
la - Latina
lad - Ladino
lb - Lëtzebuergesch
lbe - лакку
lez - лезги
lfn - Lingua Franca Nova
lg - Luganda
li - Limburgs
lij - Ligure
liv - Līvõ kēļ
lki - لەکی
lld - Ladin
lmo - lombard
ln - lingála
lo - ລາວ
loz - Silozi
lrc - لۊری شومالی
lt - lietuvių
ltg - latgaļu
lus - Mizo ţawng
luz - لئری دوٙمینی
lv - latviešu
lzh - 文言
lzz - Lazuri
mad - Madhurâ
mag - मगही
mai - मैथिली
map-bms - Basa Banyumasan
mdf - мокшень
mg - Malagasy
mh - Ebon
mhr - олык марий
mi - Māori
min - Minangkabau
mk - македонски
ml - മലയാളം
mn - монгол
mni - ꯃꯤꯇꯩ ꯂꯣꯟ
mnw - ဘာသာ မန်
mo - молдовеняскэ
mos - moore
mr - मराठी
mrh - Mara
mrj - кырык мары
ms - Bahasa Melayu
ms-arab - بهاس ملايو
mt - Malti
mus - Mvskoke
mwl - Mirandés
my - မြန်မာဘာသာ
myv - эрзянь
mzn - مازِرونی
na - Dorerin Naoero
nah - Nāhuatl
nan - Bân-lâm-gú
nap - Napulitano
nb - norsk bokmål
nds - Plattdüütsch
nds-nl - Nedersaksies
ne - नेपाली
new - नेपाल भाषा
ng - Oshiwambo
nia - Li Niha
niu - Niuē
nl - Nederlands
nl-informal - Nederlands (informeel)
nmz - nawdm
nn - norsk nynorsk
no - norsk
nod - ᨣᩤᩴᨾᩮᩬᩥᨦ
nog - ногайша
nov - Novial
nqo - ߒߞߏ
nrm - Nouormand
nso - Sesotho sa Leboa
nv - Diné bizaad
ny - Chi-Chewa
nyn - runyankore
nys - Nyunga
oc - occitan
ojb - Ojibwemowin
olo - livvinkarjala
om - Oromoo
or - ଓଡ଼ିଆ
os - ирон
pa - ਪੰਜਾਬੀ
pag - Pangasinan
pam - Kapampangan
pap - Papiamentu
pcd - Picard
pcm - Naijá
pdc - Deitsch
pdt - Plautdietsch
pfl - Pälzisch
pi - पालि
pih - Norfuk / Pitkern
pl - polski
pms - Piemontèis
pnb - پنجابی
pnt - Ποντιακά
prg - prūsiskan
ps - پښتو
pt - português
pt-br - português do Brasil
pwn - pinayuanan
qqq - Message documentation
qu - Runa Simi
qug - Runa shimi
rgn - Rumagnôl
rif - Tarifit
rki - ရခိုင်
rm - rumantsch
rmc - romaňi čhib
rmy - romani čhib
rn - ikirundi
ro - română
roa-tara - tarandíne
rsk - руски
ru - русский
rue - русиньскый
rup - armãneashti
ruq - Vlăheşte
ruq-cyrl - Влахесте
ruq-latn - Vlăheşte
rw - Ikinyarwanda
ryu - うちなーぐち
sa - संस्कृतम्
sah - саха тыла
sat - ᱥᱟᱱᱛᱟᱲᱤ
sc - sardu
scn - sicilianu
sco - Scots
sd - سنڌي
sdc - Sassaresu
sdh - کوردی خوارگ
se - davvisámegiella
se-fi - davvisámegiella (Suoma bealde)
se-no - davvisámegiella (Norgga bealde)
se-se - davvisámegiella (Ruoŧa bealde)
sei - Cmique Itom
ses - Koyraboro Senni
sg - Sängö
sgs - žemaitėška
sh - srpskohrvatski / српскохрватски
sh-cyrl - српскохрватски (ћирилица)
sh-latn - srpskohrvatski (latinica)
shi - Taclḥit
shi-latn - Taclḥit
shi-tfng - ⵜⴰⵛⵍⵃⵉⵜ
shn - ၽႃႇသႃႇတႆး
shy - tacawit
shy-latn - tacawit
si - සිංහල
simple - Simple English
sjd - кӣллт са̄мь кӣлл
sje - bidumsámegiella
sk - slovenčina
skr - سرائیکی
skr-arab - سرائیکی
sl - slovenščina
sli - Schläsch
sm - Gagana Samoa
sma - åarjelsaemien
smn - anarâškielâ
sms - nuõrttsääʹmǩiõll
sn - chiShona
so - Soomaaliga
sq - shqip
sr - српски / srpski
sr-ec - српски (ћирилица)
sr-el - srpski (latinica)
srn - Sranantongo
sro - sardu campidanesu
ss - SiSwati
st - Sesotho
stq - Seeltersk
sty - себертатар
su - Sunda
sv - svenska
sw - Kiswahili
syl - ꠍꠤꠟꠐꠤ
szl - ślůnski
szy - Sakizaya
ta - தமிழ்
tay - Tayal
tcy - ತುಳು
tdd - ᥖᥭᥰᥖᥬᥳᥑᥨᥒᥰ
te - తెలుగు
tet - tetun
tg - тоҷикӣ
tg-cyrl - тоҷикӣ
tg-latn - tojikī
th - ไทย
ti - ትግርኛ
tk - Türkmençe
tl - Tagalog
tly - tolışi
tly-cyrl - толыши
tn - Setswana
to - lea faka-Tonga
tok - toki pona
tpi - Tok Pisin
tr - Türkçe
tru - Ṫuroyo
trv - Seediq
ts - Xitsonga
tt - татарча / tatarça
tt-cyrl - татарча
tt-latn - tatarça
tum - chiTumbuka
tw - Twi
ty - reo tahiti
tyv - тыва дыл
tzm - ⵜⴰⵎⴰⵣⵉⵖⵜ
udm - удмурт
ug - ئۇيغۇرچە / Uyghurche
ug-arab - ئۇيغۇرچە
ug-latn - Uyghurche
uk - українська
ur - اردو
uz - oʻzbekcha / ўзбекча
uz-cyrl - ўзбекча
uz-latn - oʻzbekcha
ve - Tshivenda
vec - vèneto
vep - vepsän kel’
vi - Tiếng Việt
vls - West-Vlams
vmf - Mainfränkisch
vmw - emakhuwa
vo - Volapük
vot - Vaďďa
vro - võro
wa - walon
wal - wolaytta
war - Winaray
wls - Fakaʻuvea
wo - Wolof
wuu - 吴语
xal - хальмг
xh - isiXhosa
xmf - მარგალური
xsy - saisiyat
yi - ייִדיש
yo - Yorùbá
yrl - Nhẽẽgatú
yue - 粵語
za - Vahcuengh
zea - Zeêuws
zgh - ⵜⴰⵎⴰⵣⵉⵖⵜ ⵜⴰⵏⴰⵡⴰⵢⵜ
zh - 中文
zh-cn - 中文(中国大陆)
zh-hans - 中文(简体)
zh-hant - 中文(繁體)
zh-hk - 中文(香港)
zh-mo - 中文(澳門)
zh-my - 中文(马来西亚)
zh-sg - 中文(新加坡)
zh-tw - 中文(臺灣)
zu - isiZulu
Format
Export for off-line translation
Export in native format
Export in CSV format
Fetch
{{DISPLAYTITLE:Doxygen}}<languages/> <span id="About"></span> ==Sobre== {{TOCright}} Doxygen é uma ferramenta popular para gerar documentação a partir de fontes C++ anotadas; ele também suporta outras linguagens de programação populares, como C#, PHP, Java e Python. Visite o [http://www.doxygen.nl/ site da Doxygen] para saber mais sobre o sistema e consulte o [http://www.doxygen.nl/manual/index.html Manual da Doxygen](inglês) para obter as informações completas. <span id="Doxygen_and_FreeCAD"></span> == Doxygen e FreeCAD == Este documento dá uma breve introdução ao Doxygen, em particular como ele é usado no FreeCAD para documentar suas fontes. Visite a página de documentação de origem para obter instruções sobre como construir a [[source documentation/pt-br|documentação do FreeCAD]], que também está hospedada on-line no site da [https://www.freecadweb.org/api/ do FreeCAD]. [[File:FreeCAD_doxygen_workflow.svg|800px]] {{Caption|Fluxo de trabalho geral para produzir documentações de código-fonte com o Doxygen.}} <span id="Doxygen_with_C++_code"></span> == Doxygen com código C++ == A seção [http://www.doxygen.nl/manual/starting.html Introdução (Etapa 3)] do manual do Doxygen menciona as maneiras básicas de documentar as fontes. Para membros, classes e namespaces existem basicamente duas opções: #Coloque um "bloco de documentação" especial (um parágrafo comentado) antes da declaração ou definição da função, membro, classe ou namespace. Para membros de arquivo, classe e namespace (variáveis) também é permitido colocar a documentação diretamente após o membro. Consulte a seção [http://www.doxygen.nl/manual/docblocks.html#specialblock Blocos de comentários especiais] no manual para saber mais sobre esses blocos. #Coloque um bloco de documentação especial em outro lugar (outro arquivo ou outro local no mesmo arquivo) e coloque um "comando estrutural" no bloco de documentação. Um comando estrutural vincula um bloco de documentação a uma determinada entidade que pode ser documentada (uma função, membro, variável, classe, namespace ou arquivo). Consulte a seção [http://www.doxygen.nl/manual/docblocks.html#structuralcommands Documentação em outros locais] do manual para saber mais sobre comandos estruturais. Nota: * A vantagem da primeira opção é que você não precisa repetir o nome da entidade (função, membro, variável, classe ou namespace), pois o Doxygen analisará o código e extrairá as informações relevantes. * Os arquivos só podem ser documentados usando a segunda opção, já que não há como colocar um bloco de documentação antes de um arquivo. É claro que os membros do arquivo (functions, variables, typedefs, defines) não precisam de um comando estrutural explícito; apenas colocar um bloco de documentação antes ou depois deles funcionará bem. <span id="First_style:_documentation_block_before_the_code"></span> === Primeiro estilo: bloco de documentação antes do código === Normalmente, você deseja documentar o código no arquivo de cabeçalho, logo antes da declaração de classe ou do protótipo de função. Isso mantém a declaração e a documentação próximas uma da outra, por isso é fácil atualizar a última se a primeira for alterada. O bloco de documentação especial começa como um comentário no estilo C {{incode|/*}}, mas tem um asterisco adicional {{incode|/**}}; O bloco termina com uma correspondência {{incode|*/}}. Uma alternativa é usar comentários no estilo C++ com uma barra adicional {{incode|//}}. {{Code|code= /** * Returns the name of the workbench object. */ std::string name() const; /** * Set the name to the workbench object. */ void setName(const std::string&); /// remove the added TaskWatcher void removeTaskWatcher(void); }} <span id="Second_style:_documentation_block_elsewhere"></span> === Segundo estilo: bloco de documentação em outro lugar === Como alternativa, a documentação pode ser colocada em outro arquivo (ou no mesmo arquivo na parte superior ou inferior, ou onde), longe da declaração de classe ou protótipo de função. Nesse caso, você terá informações duplicadas, uma vez no arquivo de origem real e uma vez no arquivo de documentação. Primeiro arquivo, {{incode|source.h}}: {{Code|code= std::string name() const; void setName(const std::string&); }} Segundo arquivo, {{incode|source.h.dox}}: {{Code|code= /** \file source.h * \brief The documentation of source.h * * The details of this file go here. */ /** \fn std::string name() const; * \brief Returns the name of the workbench object. */ /** \fn void setName(const std::string&); * \brief Set the name to the workbench object. */ }} Nesse caso, o comando estrutural {{incode|\file}} é usado para indicar qual arquivo de origem está sendo documentado; Um comando estrutural {{incode|\fn}} indica que o código a seguir é uma função, e o comando {{incode|\brief}} é usado para fornecer uma pequena descrição dessa função. Essa maneira de documentar um arquivo de origem é útil se você quiser apenas adicionar documentação ao seu projeto sem adicionar código real. Quando você coloca um bloco de comentários em um arquivo com uma das seguintes extensões {{incode|.dox}}, {{incode|.txt}} ou {{incode|.doc}} então o Doxygen analisará os comentários e criará a documentação apropriada, mas ocultará esse arquivo auxiliar da lista de arquivos. O projeto FreeCAD adiciona vários arquivos terminandos em {{incode|.dox}}, a fim de fornecer uma descrição, ou exemplos, do código. É importante que esses arquivos sejam categorizados corretamente em um grupo ou namespace, para o qual o Doxygen fornece alguns comandos auxiliares como {{incode|\defgroup}}, {{incode|\ingroup}} e {{incode|\namespace}}. <div class="mw-collapsible mw-collapsed toccolours"> Exemplo {{incode|src/Base/core-base.dox}}; este arquivo na árvore de código fonte do FreeCAD dá uma breve explicação do namespace {{incode|Base}}. <div class="mw-collapsible-content"> {{Code|code= /** \defgroup BASE Base * \ingroup CORE \brief Basic structures used by other FreeCAD components The Base module includes most of the basic functions of FreeCAD, such as: - Console services: printing different kinds of messages to the FreeCAD report view or the terminal - Python interpreter: handles the execution of Python code in FreeCAD - Parameter handling: Management, saving and restoring of user preferences settings - Units: Management and conversion of different units */ /*! \namespace Base \ingroup BASE \brief Basic structures used by other FreeCAD components The Base module includes most of the basic functions of FreeCAD, such as: - Console services: printing different kinds of messages to the FreeCAD report view or the terminal - Python interpreter: handles the execution of Python code in FreeCAD - Parameter handling: Management, saving and restoring of user preferences settings - Units: Management and conversion of different units */ }} </div> </div> Outro exemplo é o arquivo {{incode|src/Gui/Command.cpp}}. Antes dos detalhes de implementação {{incode|Gui::Command}} dos métodos, há um bloco de documentação que explica alguns detalhes da estrutura de comando do FreeCAD. Ele tem vários comandos {{incode|\section}} para estruturar a documentação. Ele ainda inclui código de exemplo incluído em um par de palavras-chave {{incode|\code}} e {{incode|\endcode}}; quando o arquivo é processado por Doxygen, este exemplo de código será especialmente formatado para se destacar. A palavra-chave {{incode|\ref}} é usada em vários lugares para criar links para seções, subseções, páginas ou âncoras nomeadas em outros lugares da documentação. Da mesma forma, os comandos {{incode|\see}} ou {{incode|\sa}} imprimem "Consulte também" e fornecem um link para outras classes, funções, métodos, variáveis, arquivos ou URLs. <div class="mw-collapsible mw-collapsed toccolours"> Exemplo {{incode|src/Gui/Command.cpp}} <div class="mw-collapsible-content"> {{Code|code= /** \defgroup commands Command Framework \ingroup GUI \brief Structure for registering commands to the FreeCAD system * \section Overview * In GUI applications many commands can be invoked via a menu item, a toolbar button or an accelerator key. The answer of Qt to master this * challenge is the class \a QAction. A QAction object can be added to a popup menu or a toolbar and keep the state of the menu item and * the toolbar button synchronized. * * For example, if the user clicks the menu item of a toggle action then the toolbar button gets also pressed * and vice versa. For more details refer to your Qt documentation. * * \section Drawbacks * Since QAction inherits QObject and emits the \a triggered() signal or \a toggled() signal for toggle actions it is very convenient to connect * these signals e.g. with slots of your MainWindow class. But this means that for every action an appropriate slot of MainWindow is necessary * and leads to an inflated MainWindow class. Furthermore, it's simply impossible to provide plugins that may also need special slots -- without * changing the MainWindow class. * * \section wayout Way out * To solve these problems we have introduced the command framework to decouple QAction and MainWindow. The base classes of the framework are * \a Gui::CommandBase and \a Gui::Action that represent the link between Qt's QAction world and the FreeCAD's command world. * * The Action class holds a pointer to QAction and CommandBase and acts as a mediator and -- to save memory -- that gets created * (@ref Gui::CommandBase::createAction()) not before it is added (@ref Gui::Command::addTo()) to a menu or toolbar. * * Now, the implementation of the slots of MainWindow can be done in the method \a activated() of subclasses of Command instead. * * For example, the implementation of the "Open file" command can be done as follows. * \code * class OpenCommand : public Command * { * public: * OpenCommand() : Command("Std_Open") * { * // set up menu text, status tip, ... * sMenuText = "&Open"; * sToolTipText = "Open a file"; * sWhatsThis = "Open a file"; * sStatusTip = "Open a file"; * sPixmap = "Open"; // name of a registered pixmap * sAccel = "Shift+P"; // or "P" or "P, L" or "Ctrl+X, Ctrl+C" for a sequence * } * protected: * void activated(int) * { * QString filter ... // make a filter of all supported file formats * QStringList FileList = QFileDialog::getOpenFileNames( filter,QString::null, getMainWindow() ); * for ( QStringList::Iterator it = FileList.begin(); it != FileList.end(); ++it ) { * getGuiApplication()->open((*it).latin1()); * } * } * }; * \endcode * An instance of \a OpenCommand must be created and added to the \ref Gui::CommandManager to make the class known to FreeCAD. * To see how menus and toolbars can be built go to the @ref workbench. * * @see Gui::Command, Gui::CommandManager */ }} </div> </div> <span id="Example_from_the_VTK_project"></span> === Exemplo do projeto VTK === Este é um exemplo do [https://vtk.org/ VTK], uma biblioteca de visualização 3D usada para apresentar dados científicos, como resultados de elementos finitos e informações de nuvem de pontos. Uma classe para armazenar uma coleção de coordenadas é definida em um arquivo de cabeçalho C++. A parte superior do arquivo é comentada, e algumas palavras-chave são usadas, como {{incode|@class}}, {{incode|@brief}} e {{incode|@sa}} para indicar partes importantes. Dentro da classe, antes dos protótipos do método de classe, um bloco de texto comentado explica o que a função faz e seus argumentos. * Código fonte de [https://github.com/Kitware/VTK/blob/master/Common/Core/vtkArrayCoordinates.h vtkArrayCoordinates.h]. * Doxygen produziu documentação para a [http://www.vtk.org/doc/nightly/html/classvtkArrayCoordinates.html classe vtkArrayCoordinates]. <span id="Compiling_the_documentation"></span> == Compilando a documentação == [[File:FreeCAD_doxygen_workflow.svg|800px]] {{Caption|Fluxo de trabalho geral para produzir documentação de código-fonte com o Doxygen.}} Para gerar a documentação do código-fonte, há duas etapas básicas: # Crie um arquivo de configuração para controlar como o Doxygen processará os arquivos de origem. # Execute {{incode|doxygen}} nessa configuração. <div class="mw-collapsible mw-collapsed toccolours"> O processo é descrito a seguir. <div class="mw-collapsible-content"> * Certifique-se de ter os programas {{incode|doxygen}} e {{incode|doxywizard}} em seu sistema. Também é recomendado ter o {{incode|dot}} programa do [https://www.graphviz.org/ Graphviz], a fim de gerar diagramas com as relações entre classes e namespaces. Em sistemas Linux, esses programas podem ser instalados a partir do seu gerenciador de pacotes. {{Code|code= sudo apt install doxygen doxygen-gui graphviz }} * Verifique se você está na mesma pasta que os arquivos de origem ou no diretório de nível superior da árvore de código-fonte, se você tiver muitos arquivos de código-fonte em subdiretórios diferentes. {{Code|code= cd toplevel-source }} * Execute {{incode|doxygen -g DoxyDoc.cfg}} para criar um arquivo de configuração chamado {{incode|DoxyDoc.cfg}}. Se você omitir esse nome, o arquivo {{incode|Doxyfile}} ficara sem uma extensão. * Este é um arquivo de texto grande e simples que inclui muitas variáveis com seus valores. No manual do Doxygen essas variáveis são chamadas de "tags". O arquivo de configuração e todas as tags são descritos extensivamente na seção [http://www.doxygen.nl/manual/config.html Configuração] do manual. Você pode abrir o arquivo com qualquer editor de texto e editar o valor de cada tag conforme necessário. No mesmo arquivo, você pode ler comentários explicando cada uma das marcas e seus valores padrão. {{Code|code= DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = "My Project" PROJECT_NUMBER = PROJECT_BRIEF = PROJECT_LOGO = OUTPUT_DIRECTORY = CREATE_SUBDIRS = NO ALLOW_UNICODE_NAMES = NO BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES ... }} * Em vez de usar um editor de texto, você pode iniciar {{incode|doxywizard}} para editar muitas tags ao mesmo tempo. Com esta interface você pode definir muitas propriedades, como informações do projeto, tipo de saída (HTML e LaTeX), uso do Graphviz para criar diagramas, mensagens de aviso para exibir, padrões de arquivo (extensões) para documentar ou excluir, filtros de entrada, cabeçalhos e rodapés opcionais para as páginas geradas em HTML, opções para saídas LaTeX, RTF, XML ou Docbook e muitas outras opções. {{Code|code= doxywizard DoxyDoc.cfg }} * Outra opção é criar o arquivo de configuração do zero e adicionar apenas as tags desejadas com um editor de texto. * Depois que a configuração for salva, você poderá executar o Doxygen neste arquivo de configuração. {{Code|code= doxygen DoxyDoc.cfg }} * A documentação gerada será criada dentro de uma pasta chamada {{incode|toplevel-source/html}}. Ele consistirá em muitas páginas HTML, imagens PNG para gráficos, folhas de estilo em cascata ({{incode|.css}}), arquivos Javascript ({{incode|.js}}) e potencialmente muitos subdiretórios com mais arquivos, dependendo do tamanho do seu código. O ponto de entrada na documentação é {{incode|index.html}}, que você pode abrir com um navegador da Web. {{Code|code= xdg-open toplevel-source/html/index.html }} </div> </div> Se você estiver escrevendo novas classes, funções ou um novo workbench inteiro, é recomendável executar {{incode|doxygen}} periodicamente para ver se os blocos de documentação, [[#Markdown support|Markdown]] e [[#Doxygen markup|comandos especiais]] estão sendo lidos corretamente e se todas as funções públicas estão totalmente documentadas. Leia também as [https://github.com/FreeCAD/FreeCAD/blob/master/src/Doc/doctips.dox dicas de documentação] localizadas no código-fonte. Ao gerar a documentação completa do FreeCAD, você não executa {{incode|doxygen}} diretamente. Em vez disso, o projeto usa {{incode|cmake}} para configurar o ambiente de compilação e, em seguida {{incode|make}}, dispara a compilação dos códigos-fonte do FreeCAD e da documentação do Doxygen; isso é explicado na página de [[source documentation|documentação de origem]]. <span id="Doxygen_markup"></span> == Marcações de Doxygen == Todos os [http://www.doxygen.nl/manual/commands.html comandos da documentação] do Doxygen começam com uma barra invertida {{incode|\}} ou um arroba {{incode|@}}, de sua preferência. Normalmente, a barra invertida {{incode|\}} é usada, mas ocasionalmente {{incode|@}} é usada para melhorar a legibilidade. Os comandos podem ter um ou mais argumentos. No manual do Doxygen, os argumentos são descritos a seguir. * Se {{incode|<sharp>}} forem usadas chaves, o argumento será uma única palavra. * Se {{incode|(round)}} forem usadas chaves, o argumento se estenderá até o final da linha na qual o comando foi encontrado. * Se <code>{curly}</code> forem usadas chaves, o argumento se estende até o próximo parágrafo. Os parágrafos são delimitados por uma linha em branco ou por um indicador de seção. * Se {{incode|[square]}} forem usados colchetes, o argumento será opcional. <div class="mw-collapsible mw-collapsed toccolours"> Algumas das palavras-chave mais comuns usadas na documentação do FreeCAD são apresentadas aqui. <div class="mw-collapsible-content"> * <code>\defgroup <name> (group title) </code>, consulte [http://www.doxygen.nl/manual/commands.html#cmddefgroup \defgroup], e [http://www.doxygen.nl/manual/grouping.html Grouping]. * <code>\ingroup (<groupname> [<groupname> <groupname>])</code>, consulte [http://www.doxygen.nl/manual/commands.html#cmdingroup \ingroup], e [http://www.doxygen.nl/manual/grouping.html Grouping]. * <code>\addtogroup <name> [(title)]</code>, consulte [http://www.doxygen.nl/manual/commands.html#cmdaddtogroup \addtogroup], e [http://www.doxygen.nl/manual/grouping.html Grouping]. * <code>\author { list of authors }</code>, veja [http://www.doxygen.nl/manual/commands.html#cmdauthor \author]; indica o autor deste pedaço de código. * <code>\brief { brief description }</code>, veja [http://www.doxygen.nl/manual/commands.html#cmdbrief \brief]; descreve brevemente a função. * <code>\file [<name>]</code>, consulte [http://www.doxygen.nl/manual/commands.html#cmdfile \file]; documenta um arquivo de origem ou de cabeçalho. * <code>\page <name> (title)</code>, consulte [http://www.doxygen.nl/manual/commands.html#cmdpage \page]; coloca as informações em uma página separada, não diretamente relacionada a uma classe, arquivo ou membro específico. * <code>\package <name></code>, consulte [http://www.doxygen.nl/manual/commands.html#cmdpackage \package]; indica documentação para um pacote Java (mas também usado com Python). * <code>\fn (function declaration)</code>, veja [http://www.doxygen.nl/manual/commands.html#cmdfn \fn]; documenta uma função. * <code>\var (variable declaration)</code>, veja [http://www.doxygen.nl/manual/commands.html#cmdvar \var]; documenta uma variável; é equivalente a {{incode|\fn}}, {{incode|\property}} e {{incode|\typedef}}. * <code>\section <section-name> (section title)</code>, consulte [http://www.doxygen.nl/manual/commands.html#cmdsection \section]; inicia uma seção. * <code>\subsection <subsection-name> (subsection title)</code>, consulte [http://www.doxygen.nl/manual/commands.html#cmdsubsection \subsection]; inicia uma subseção. * <code>\namespace <name></code>, consulte [http://www.doxygen.nl/manual/commands.html#cmdnamespace \namespace]; indica informações para um namespace. * <code>\cond [(section-label)]</code>, e <code>\endcond</code>, veja [http://www.doxygen.nl/manual/commands.html#cmdcond \cond]; Define um bloco para documentar condicionalmente ou omitir. * <code>\a <word></code>, veja [http://www.doxygen.nl/manual/commands.html#cmda \a]; exibe o argumento em itálico para ênfase. * <code>\param [(dir)] <parameter-name> { parameter description }</code>, veja [http://www.doxygen.nl/manual/commands.html#cmdparam \param]; Indica o parâmetro de uma função. * <code>\return { description of the return value }</code>, consulte [http://www.doxygen.nl/manual/commands.html#cmdreturn \return]; Especifica o valor de retorno. * <code>\sa { references }</code>, consulte [http://www.doxygen.nl/manual/commands.html#cmdsa \sa]; imprime "See also". * <code>\note { text }</code>, veja [http://www.doxygen.nl/manual/commands.html#cmdnote \note]; adiciona um parágrafo para ser usado como uma nota. </div> </div> <span id="Markdown_support"></span> == Suporte a Markdown == Desde o Doxygen 1.8, a sintaxe Markdown é reconhecida em blocos de documentação. Markdown é uma linguagem de formatação minimalista inspirada em e-mail de texto simples que, semelhante à sintaxe wiki, pretende ser simples e legível sem exigir código complicado como o encontrado em HTML, LaTeX ou comandos do próprio Doxygen. Markdown ganhou popularidade com o software livre, especialmente em plataformas online como o Github, pois permite criar documentação sem usar código complicado. Consulte a seção [http://www.doxygen.nl/manual/markdown.html Suporte a Markdown] no manual do Doxygen para saber mais. Visite o [https://daringfireball.net/projects/markdown/ site da Markdown] para saber mais sobre a origem e a filosofia da Markdown. O Doxygen suporta um conjunto padrão de instruções de Markdown, bem como algumas extensões, como o [https://github.github.com/github-flavored-markdown/ Github Markdown]. <div class="mw-collapsible mw-collapsed toccolours"> Alguns exemplos de formatação Markdown são apresentados a seguir. <div class="mw-collapsible-content"> A seguir está o Markdown padrão. {{Code|code= Here is text for one paragraph. We continue with more text in another paragraph. This is a level 1 header ======================== This is a level 2 header ------------------------ # This is a level 1 header ### This is level 3 header ####### > This is a block quote > spanning multiple lines - Item 1 More text for this item. - Item 2 * nested list item. * another nested item. - Item 3 1. First item. 2. Second item. *single asterisks: emphasis* _single underscores_ **double asterisks: strong emphasis** __double underscores__ This a normal paragraph This is a code block We continue with a normal paragraph again. Use the `printf()` function. Inline `code`. [The link text](http://example.net/) ![Caption text](/path/to/img.jpg) <http://www.example.com> }} A seguir estão as extensões Markdown. <pre> [TOC] First Header | Second Header ------------- | ------------- Content Cell | Content Cell Content Cell | Content Cell <nowiki>~~~~~~~~~~~~~</nowiki>{.py} # A class class Dummy: pass <nowiki>~~~~~~~~~~~~~</nowiki> <nowiki>~~~~~~~~~~~~~</nowiki>{.c} int func(int a, int b) { return a*b; } <nowiki>~~~~~~~~~~~~~</nowiki> ``` int func(int a, int b) { return a*b; } ``` </pre> </div> </div> <span id="Parsing_of_documentation_blocks"></span> == Análise de blocos de documentação == O texto dentro de um bloco de documentação especial é analisado antes de ser gravado nos arquivos de saída HTML e LaTeX. Durante a análise, as seguintes etapas ocorrem: * A formatação Markdown é substituída por comandos HTML ou especiais correspondentes. * Os comandos especiais dentro da documentação são executados. Consulte a seção [http://www.doxygen.nl/manual/commands.html Comandos especiais] no manual para obter uma explicação de cada comando. * Se uma linha começar com algum espaço em branco seguido por um ou mais asteriscos ({{incode|*}}) e, opcionalmente, mais espaço em branco, todos os espaços em branco e asteriscos serão removidos.* * Todas as linhas em branco resultantes são tratadas como separadores de parágrafo. * Os links são criados automaticamente para palavras correspondentes a classes ou funções documentadas. Se a palavra for precedida por um símbolo de porcentagem {{incode|%}}, esse símbolo será removido e nenhum link será criado para a palavra. * Os links são criados quando determinados padrões são encontrados no texto. Consulte a seção [http://www.doxygen.nl/manual/autolink.html Geração automática de links] no manual para obter mais informações. * As tags HTML que estão na documentação são interpretadas e convertidas em equivalentes LaTeX para a saída LaTeX. Consulte a seção [http://www.doxygen.nl/manual/htmlcmds.html Comandos HTML] no manual para obter uma explicação de cada tag HTML suportada. <span id="Doxygen_with_Python_code"></span> == Doxygen com código Python == Doxygen funciona melhor para linguagens tipadas estaticamente como C++. No entanto, ele também pode criar [http://www.doxygen.nl/manual/docblocks.html#pythonblocks documentação para arquivos Python]. Há duas maneiras de escrever blocos de documentação para Python: # O modo pythonico, usando "docstrings", ou seja, um bloco de texto cercado por <code><nowiki>'''aspas triplas'''</nowiki></code> imediatamente após a definição da classe ou função. # O modo Doxygen, colocando os comentários antes da definição da classe ou função; Nesse caso, caracteres de cerquilha dupla {{incode|##}} são usados para iniciar o bloco de documentação e, em seguida, um único caractere de hash pode ser usado nas linhas subsequentes. Nota: * A primeira opção é preferível para cumprir com [https://www.python.org/dev/peps/pep-0008/#documentation-strings PEP8], [https://www.python.org/dev/peps/pep-0257/ PEP257] e a maioria das diretrizes de estilo para escrever Python (veja [https://realpython.com/python-pep8/ 1], [https://realpython.com/documenting-python-code/ 2]). Recomenda-se usar esse estilo se você pretende produzir fontes documentadas usando o [https://www.sphinx-doc.org/en/master/ Sphinx], que é uma ferramenta muito comum para documentar código Python. Se você usar esse estilo, o Doxygen poderá extrair os comentários textualmente, mas os comandos especiais do Doxygen começando com {{incode|\}} ou {{incode|@}} não funcionarão. * A segunda opção não é o estilo Python tradicional, mas permite que você use os comandos especiais do Doxygen, como {{incode|\param}} e {{incode|\var}} . <span id="First_style:_Pythonic_documentation"></span> === Primeiro estilo: documentação pythonica === No exemplo a seguir, um docstring está no início para explicar o conteúdo geral deste módulo (arquivo). Em seguida, docstrings aparecem dentro das definições de método de função, classe e classe. Desta forma, Doxygen irá extrair os comentários e apresentá-los como estão, sem modificação. {{Code|code= '''@package pyexample_a Documentation for this module. More details. ''' def func(): '''Documentation for a function. More details. ''' pass class PyClass: '''Documentation for a class. More details. ''' def __init__(self): '''The constructor.''' self._memVar = 0 def PyMethod(self): '''Documentation for a method.''' pass }} <span id="Second_style:_documentation_block_before_the_code"></span> === Segundo estilo: bloco de documentação antes do código === No exemplo a seguir, os blocos de documentação começam com sinal de cerquilha dupla {{incode|##}}. Um aparece no início para explicar o conteúdo geral deste módulo (arquivo). Em seguida, há blocos antes das definições de função, classe e método de classe, e há um bloco após uma variável de classe. Dessa forma, o Doxygen extrairá a documentação, reconhecerá os comandos especiais {{incode|@package}}, {{incode|@param}} e {{incode|@var}}, e formatará o texto de acordo. {{Code|code= ## @package pyexample_b # Documentation for this module. # # More details. ## Documentation for a function. # # More details. def func(): pass ## Documentation for a class. # # More details. class PyClass: ## The constructor. def __init__(self): self._memVar = 0 ## Documentation for a method. # @param self The object pointer. def PyMethod(self): pass ## A class variable. classVar = 0 ## @var _memVar # a member variable }} <span id="Compiling_the_documentation"></span> === Compilando a documentação === A compilação da documentação procede da mesma forma que [[#Compiling the documentation|para fontes C++]]. Se ambos os arquivos Python {{incode|pyexample_a.py}} e {{incode|pyexample_b.py}}, com estilo de comentário distinto estiverem no mesmo diretório, ambos serão processados. {{Code|code= cd toplevel-source/ doxygen -g doxygen Doxyfile xdg-open ./html/index.html }} A documentação deve mostrar informações semelhantes às seguintes e criar links apropriados para os módulos e classes individuais. {{Code|code= Class List Here are the classes, structs, unions and interfaces with brief descriptions: N pyexample_a C PyClass N pyexample_b Documentation for this module C PyClass Documentation for a class }} <span id="Converting_the_Pythonic_style_to_Doxygen_style"></span> === Convertendo o estilo Pythonic para o estilo Doxygen === No exemplo anterior, o arquivo Python que é comentado em um [[#Second style: documentation block before the code|estilo Doxygen]]estilo Doxygen mostra informações mais detalhadas e formatação para suas classes, funções e variáveis. A razão é que esse estilo permite que Doxygen extraia os comandos especiais que começam com {{incode|\}} ou {{incode|@}}, enquanto o [[#First style: Pythonic documentation|estilo Pythonic]] não. Portanto, seria desejável converter o estilo Pythonic para o estilo Doxygen antes de compilar a documentação. Isso é possível com um programa Python auxiliar chamado [https://github.com/Feneric/doxypypy doxypypy]. Este programa é inspirado em um programa mais antigo chamado [https://github.com/Feneric/doxypy doxypy], que pegaria o Pythonic <code><nowiki>'''docstrings'''</nowiki></code> e os converteria para os blocos de comentários Doxygen que começam com cerquilha dupla {{incode|##}}. O Doxypypy vai além disso, pois analisa os docstrings e extrai itens de interesse, como variáveis e argumentos, e até mesmo doctests (código de exemplo nos docstrings). O Doxypypy pode ser instalado usando o {{incode|pip}}, o instalador do pacote Python. {{Code|code= pip3 install --user doxypypy }} Se o comando {{incode|pip}} for usado sem a opção {{incode|--user}}, ele exigirá privilégios de superusuário (root) para instalar o pacote, mas isso não é necessário na maioria dos casos; Use permissões de root somente se tiver certeza de que o pacote não colidirá com os pacotes fornecidos pela distribuição. Se o pacote foi instalado como um usuário, ele pode residir em seu diretório pessoal, por exemplo, em {{incode|$HOME/.local/bin}}. Se este diretório não estiver no {{incode|PATH}} do seu sistema, o programa não será encontrado. Portanto, adicione o diretório {{incode|$HOME/.bashrc}} à variável {{incode|PATH}}, no arquivo ou no arquivo {{incode|$HOME/.profile}}. {{Code|code= export PATH="$HOME/.local/bin:$PATH" }} Como alternativa, você pode criar um link simbólico para o programa {{incode|doxypypy}}, colocando o link em um diretório que já está incluído no {{incode|PATH}}. {{Code|code= mkdir -p $HOME/bin ln -s $HOME/.local/bin/doxypypy $HOME/bin/doxypypy }} Uma vez que o programa {{incode|doxypypy}} é instalado, e acessível a partir do terminal, um arquivo Python com docstrings Pythonic pode ser reformatado para o estilo Doxygen com as seguintes instruções. O programa gera a saída do código reformatado para a saída padrão, portanto, redirecione essa saída para um novo arquivo. {{Code|code= doxypypy -a -c pyexample_pythonic.py > pyexample_doxygen.py }} <div class="mw-collapsible mw-collapsed toccolours"> {{incode|pyexample_pythonic.py}} <div class="mw-collapsible-content"> {{Code|code= '''@package pyexample_pythonic Documentation for this module. More details go here. ''' def myfunction(arg1, arg2, kwarg='whatever.'): ''' Does nothing more than demonstrate syntax. This is an example of how a Pythonic human-readable docstring can get parsed by doxypypy and marked up with Doxygen commands as a regular input filter to Doxygen. Args: arg1: A positional argument. arg2: Another positional argument. Kwargs: kwarg: A keyword argument. Returns: A string holding the result. Raises: ZeroDivisionError, AssertionError, & ValueError. Examples: >>> myfunction(2, 3) '5 - 0, whatever.' >>> myfunction(5, 0, 'oops.') Traceback (most recent call last): ... ZeroDivisionError: integer division or modulo by zero >>> myfunction(4, 1, 'got it.') '5 - 4, got it.' >>> myfunction(23.5, 23, 'oh well.') Traceback (most recent call last): ... AssertionError >>> myfunction(5, 50, 'too big.') Traceback (most recent call last): ... ValueError ''' assert isinstance(arg1, int) if arg2 > 23: raise ValueError return '{0} - {1}, {2}'.format(arg1 + arg2, arg1 / arg2, kwarg) }} </div> </div> <div class="mw-collapsible mw-collapsed toccolours"> {{incode|pyexample_doxygen.py}} <div class="mw-collapsible-content"> {{Code|code= ##@package pyexample_pythonic #Documentation for this module. #More details go here. # ## @brief Does nothing more than demonstrate syntax. # # This is an example of how a Pythonic human-readable docstring can # get parsed by doxypypy and marked up with Doxygen commands as a # regular input filter to Doxygen. # # # @param arg1 A positional argument. # @param arg2 Another positional argument. # # # @param kwarg A keyword argument. # # @return # A string holding the result. # # # @exception ZeroDivisionError # @exception AssertionError # @exception ValueError. # # @b Examples # @code # >>> myfunction(2, 3) # '5 - 0, whatever.' # >>> myfunction(5, 0, 'oops.') # Traceback (most recent call last): # ... # ZeroDivisionError: integer division or modulo by zero # >>> myfunction(4, 1, 'got it.') # '5 - 4, got it.' # >>> myfunction(23.5, 23, 'oh well.') # Traceback (most recent call last): # ... # AssertionError # >>> myfunction(5, 50, 'too big.') # Traceback (most recent call last): # ... # ValueError # @endcode # def myfunction(arg1, arg2, kwarg='whatever.'): assert isinstance(arg1, int) if arg2 > 23: raise ValueError return '{0} - {1}, {2}'.format(arg1 + arg2, arg1 / arg2, kwarg) }} </div> </div> O arquivo original tem um comentário na parte superior <code><nowiki>'''@package pyexample_pythonic</nowiki></code> que indica o módulo ou namespace que está sendo descrito pelo arquivo. Essa palavra-chave {{incode|@package}} não é interpretada ao usar aspas triplas no bloco de comentários. No novo arquivo, o estilo de comentário é alterado para que a linha se torne {{incode|##@package pyexample_pythonic}}, que agora será interpretada por Doxygen. No entanto, para ser interpretado corretamente, o argumento precisa ser editado manualmente para corresponder ao novo nome do módulo (arquivo); depois de fazer isso a linha deve ser {{incode|##@package pyexample_doxygen}}. <div class="mw-collapsible mw-collapsed toccolours"> {{incode|pyexample_doxygen.py}} (o topo é editado manualmente, o resto permanece o mesmo) <div class="mw-collapsible-content"> {{Code|code= ##@package pyexample_doxygen #Documentation for this module. #More details go here. # }} </div> </div> Para compilar, crie a configuração e execute {{incode|doxygen}} no diretório de nível superior que contém os arquivos. {{Code|code= cd toplevel-source/ doxygen -g doxygen Doxyfile xdg-open ./html/index.html }} A documentação deve mostrar informações semelhantes às seguintes e criar links apropriados para os módulos individuais. {{Code|code= Namespace List Here is a list of all documented namespaces with brief descriptions: N pyexample_doxygen Documentation for this module N pyexample_pythonic }} <span id="Converting_the_comment_style_on_the_fly"></span> === Convertendo o estilo de comentário em tempo real === No exemplo anterior, a conversão dos blocos de documentação era feita manualmente com apenas um arquivo de origem. Idealmente, queremos que essa conversão ocorra automaticamente, em tempo real, com qualquer número de arquivos Python. Para fazer isso, a configuração Doxygen deve ser editada de acordo. Para começar, não use o programa {{incode|doxypypy}} diretamente; Em vez disso, crie o arquivo de configuração com {{incode|doxygen -g}}, edite o {{incode|Doxyfile}}, criado e modifique a marca a seguir. {{Code|code= FILTER_PATTERNS = *.py=doxypypy_filter }} O que isso faz é que os arquivos que correspondem ao padrão, todos os arquivos com uma extensão terminando em {{incode|.py}}, passarão pelo programa {{incode|doxypypy_filter}}. Toda vez que Doxygen encontrar esse arquivo na árvore de origem, o nome do arquivo será passado como o primeiro argumento para este programa. {{Code|code= doxypypy_filter example.py }} O programa {{incode|doxypypy_filter}} não existe por padrão; ele deve ser criado como um shell script para {{incode|doxypypy}} ser executado com as opções apropriadas e tomar um arquivo como seu primeiro argumento. {{Code|code= #!/bin/sh doxypypy -a -c "$1" }} Depois de salvar esse shell script, verifique se ele tem permissões de execução e se está localizado em um diretório contido no {{incode|PATH}}. {{Code|code= chmod a+x doxypypy_filter mv doxypypy_filter $HOME/bin }} Em sistemas Windows, um arquivo em lotes pode ser usado de maneira semelhante. {{Code|code= doxypypy -a -c %1 }} Com essa configuração feita, o comando {{incode|doxygen Doxyfile}} pode ser executado para gerar a documentação como de costume. Cada arquivo Python usando Pythonic <code><nowiki>'''triple quotes'''</nowiki></code> será reformatado em tempo real para usar comentários de estilo {{incode|##Doxygen}} e, em seguida, será processado pelo Doxygen, que agora será capaz de interpretar os [[#Doxygen markup|scomandos especiais]] e a [[#Markdown support|sintaxe Mardown]]. O código-fonte original não será modificado, e nenhum arquivo temporário com um nome diferente precisa ser criado como na [[#Converting the Pythonic style to Doxygen style|seção anterior]]; Portanto, se uma instrução {{incode|@package example}} for encontrada, ela não precisará ser alterada manualmente. Observe que os arquivos Python existentes que já usam o estilo {{incode|##double hash}} para seus blocos de comentários {{incode|doxypypy}} não serão afetados pelo filtro e serão processados pelo Doxygen normalmente. [[File:FreeCAD_doxygen_doxypypy_workflow.svg|800px]] {{Caption|Fluxo de trabalho geral para produzir documentação de código-fonte com Doxygen, quando os arquivos Python são filtrados para transformar os blocos de comentários.}} <span id="Python_code_quality_check"></span> === Verificação de qualidade do código Python === Para usar a conversão automática de blocos de documentação é importante que os fontes originais do Python estejam corretamente escritos, seguindo as diretrizes pythonicas no [https://www.python.org/dev/peps/pep-0008/#documentation-strings PEP8]e [https://www.python.org/dev/peps/pep-0257/ PEP257]. O código escrito de forma desleixada fará com que {{incode|doxypypy}} falhe ao processar o arquivo e, portanto, o Doxygen não conseguirá formatar a documentação corretamente. <div class="mw-collapsible mw-collapsed toccolours"> Os estilos de comentários a seguir não permitirão a análise das cadeias de caracteres doc pelo {{incode|doxypypy}}, portanto, eles devem ser evitados. <div class="mw-collapsible-content"> {{Code|code= '''@package Bad ''' def first_f(one, two): "Bad comment 1" result = one + two result_m = one * two return result, result_m def second_f(one, two): "Bad comment 2" result = one + two result_m = one * two return result, result_m def third_f(one, two): 'Bad comment 3' result = one + two result_m = one * two return result, result_m def fourth_f(one, two): #Bad comment 4 result = one + two result_m = one * two return result, result_m }} </div> </div> Sempre use aspas triplas para as cadeias de caracteres doc e certifique-se de que elas sigam imediatamente a declaração de classe ou função. Também é uma boa ideia verificar a qualidade do seu código Python com uma ferramenta como o [http://flake8.pycqa.org/en/latest/ flake8]([https://gitlab.com/pycqa/flake8 Gitlab]). Flake8 combina principalmente três ferramentas, [https://github.com/PyCQA/pyflakes Pyflakes], [https://github.com/PyCQA/pycodestyle Pycodestyle](anteriormente pep8) e o [https://github.com/PyCQA/mccabe verificador de complexidade McCabe], a fim de impor o estilo Python adequado. {{Code|code= pip install --user flake8 flake8 example.py }} Para verificar todos os arquivos dentro de uma árvore de código fonte use {{incode|find}}. {{Code|code= find toplevel-source/ -name '*.py' -exec flake8 {} '+' }} Se o projeto exigir, algumas verificações de código consideradas muito rígidas podem ser ignoradas. Os códigos de erro podem ser consultados na [https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes documentação do Pycodestyle]. {{Code|code= find toplevel-source/ -name '*.py' -exec flake8 --ignore=E266,E402,E722,W503 --max-line-length=100 {} '+' }} Da mesma forma, um programa que verifica principalmente se os comentários estão em conformidade com o [https://www.python.org/dev/peps/pep-0257/ PEP257] é o [https://github.com/PyCQA/pydocstyle Pydocstyle]. Os códigos de erro podem ser consultados na [http://www.pydocstyle.org/en/4.0.0/error_codes.html documentação do Pydocstyle]. {{Code|code= pip install --user pydocstyle pydocstyle example.py }} Use-o também {{incode|find}} para executar verificações docstring em todos os arquivos de origem. {{Code|code= find toplevel-source/ -name '*.py' -exec pydocstyle {} '+' }} <span id="Source_documentation_with_Sphinx"></span> == Documentação de origem com Sphinx == [https://www.sphinx-doc.org/en/master/ Sphinx]é o sistema mais popular para documentar o código-fonte do Python. No entanto, como as principais funções e bancadas de trabalho do FreeCAD são escritas em C++, considerou-se que o Doxygen é uma melhor ferramenta de documentação para este projeto. Embora o Sphinx possa analisar nativamente docstrings do Python, ele requer um pouco mais de trabalho para analisar fontes C++. O projeto [https://breathe.readthedocs.io/en/latest/ Breathe] ([https://github.com/michaeljones/breathe Github]) é uma tentativa de preencher a lacuna entre Sphinx e Doxygen, a fim de integrar a documentação de código fonte Python e C++ no mesmo sistema. Primeiro, o Doxygen precisa ser configurado para gerar um arquivo XML; a saída XML é então lida pelo Breathe e convertida em entrada adequada para o Sphinx. Consulte o [https://breathe.readthedocs.io/en/latest/quickstart.html Guia de início rápido] na documentação do Breathe para saber mais sobre esse processo. Consulte esta resposta em [https://stackoverflow.com/a/35377654 Stackoverflow] para obter outras alternativas para documentar código C++ e Python juntos no mesmo projeto. <span id="Related"></span> == Relacionado == * [[Source_documentation|Documentação de origem]] * [https://www.freecadweb.org/api/ Site da API FreeCAD] [[Category:Developer_Documentation{{#translation:}}]] [[Category:Developer{{#translation:}}]] [[Category:3rd Party{{#translation:}}]]