Cleanup in doxygen stuff
This commit is contained in:
Yorik van Havre
6
src/3rdParty/salomesmesh/salomesmesh.dox
vendored
Normal file
6
src/3rdParty/salomesmesh/salomesmesh.dox
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
/**
|
||||
\defgroup SMESH Salome SMESH
|
||||
\ingroup EMBEDDED
|
||||
\brief The Salome SMESH module is used in Fem and Mesh workbenches
|
||||
|
||||
*/
|
||||
@@ -1,4 +1,4 @@
|
||||
/** \defgroup APP App side
|
||||
/** \defgroup APP App
|
||||
* \ingroup CORE
|
||||
* \brief The part of FreeCAD that works without GUI (console or server mode)
|
||||
*/
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
/*! \namespace Base
|
||||
\ingroup BASE
|
||||
\brief Basic structures used by other FreeCAD components
|
||||
\brief Basic structures used by other FreeCAD components (C++ API)
|
||||
|
||||
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
|
||||
|
||||
@@ -1,5 +1,35 @@
|
||||
/**
|
||||
\defgroup PYCXX PyCXX
|
||||
\ingroup EMBEDDED
|
||||
\brief C++ facilities to make it easier to write Python extensions
|
||||
|
||||
CXX/Objects is a set of C++ facilities to make it easier to write
|
||||
Python extensions. The chief way in which PyCXX makes it easier to
|
||||
write Python extensions is that it greatly increases the probability
|
||||
that your program will not make a reference-counting error and will
|
||||
not have to continually check error returns from the Python C API.
|
||||
CXX/Objects integrates Python with C++ in these ways:
|
||||
|
||||
C++ exception handling is relied on to detect errors and clean up.
|
||||
In a complicated function this is often a tremendous problem when
|
||||
writing in C. With PyCXX, we let the compiler keep track of what
|
||||
objects need to be dereferenced when an error occurs.
|
||||
The Standard Template Library (STL) and its many algorithms plug and
|
||||
play with Python containers such as lists and tuples.
|
||||
The optional CXX/Extensions facility allows you to replace the
|
||||
clumsy C tables with objects and method calls that define your
|
||||
modules and extension objects.
|
||||
|
||||
PyCXX documentation is split into <a
|
||||
HREF="http://cxx.sourceforge.net/PyCXX-Python3.html">Python 3</A> and
|
||||
<A HREF="http://cxx.sourceforge.net/PyCXX-Python2.html">Python 2</A>
|
||||
versions. The Python 3 documentation is the most accurate.
|
||||
|
||||
Latest <A HREF="http://cxx.sourceforge.net/README.html">PyCXX
|
||||
README</A> file
|
||||
|
||||
The source code is released under the <A
|
||||
HREF="https://sourceforge.net/p/cxx/code/HEAD/tree/trunk/CXX/COPYRIGHT">BSD
|
||||
License</A>.
|
||||
|
||||
*/
|
||||
|
||||
@@ -193,7 +193,7 @@ OPTIMIZE_OUTPUT_FOR_C = NO
|
||||
# Java. For instance, namespaces will be presented as packages, qualified
|
||||
# scopes will look different, etc.
|
||||
|
||||
OPTIMIZE_OUTPUT_JAVA = NO
|
||||
OPTIMIZE_OUTPUT_JAVA = YES
|
||||
|
||||
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
|
||||
# sources only. Doxygen will then generate output that is more tailored for
|
||||
|
||||
@@ -65,7 +65,7 @@ if(DOXYGEN_FOUND)
|
||||
${CMAKE_BINARY_DIR}/src/Gui
|
||||
${CMAKE_SOURCE_DIR}/src/Mod
|
||||
${CMAKE_BINARY_DIR}/src/Mod
|
||||
${CMAKE_SOURCE_DIR}/src/Main
|
||||
#${CMAKE_SOURCE_DIR}/src/Main #nothing to document there ATM...
|
||||
${CMAKE_SOURCE_DIR}/src/Doc
|
||||
)
|
||||
STRING(REGEX REPLACE ";" " " DOXYGEN_INPUT_LIST "${DOXYGEN_SOURCE_DIR}")
|
||||
@@ -75,8 +75,6 @@ if(DOXYGEN_FOUND)
|
||||
# src/3rdParty/CxImage : Windows thumbnailer
|
||||
set( DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Tools)
|
||||
list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/3rdParty/CxImage)
|
||||
list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/3rdParty/salomesmesh)
|
||||
list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Mod/Arch/Dice3DS)
|
||||
list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Doc/sphinx)
|
||||
# deprecated modules
|
||||
list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Mod/Assembly)
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
|
||||
/**
|
||||
|
||||
\if WEB_DOCUMENTATION
|
||||
|
||||
|
||||
\mainpage FreeCAD source documentation
|
||||
|
||||
@@ -50,7 +50,7 @@
|
||||
the source code documentation</a>. You can also browse through the <a href=https://github.com/FreeCAD/FreeCAD>source
|
||||
code on github</a>.
|
||||
|
||||
\endif
|
||||
|
||||
|
||||
\if DEV_DOCUMENTATION
|
||||
|
||||
|
||||
@@ -1,9 +1,10 @@
|
||||
/** \defgroup CORE Core
|
||||
This is the core functionality of FreeCAD.
|
||||
These are the core components of FreeCAD.
|
||||
|
||||
It groups the Base classes, and the main components of FreeCAD core,
|
||||
spread over their App and Gui sides. Core components are programmed in
|
||||
C++ but provide a broad Python API.
|
||||
C++ but provide a broad Python API too. Most of FreeCAD functionality,
|
||||
however, is defined in Workbenches.
|
||||
*/
|
||||
|
||||
/** \defgroup WORKBENCHES Workbenches
|
||||
|
||||
@@ -22,43 +22,5 @@ $generatedby  <a href="http://www.doxygen.org/index.html">
|
||||
</a> $doxygenversion
|
||||
</small></address>
|
||||
<!--END !GENERATE_TREEVIEW-->
|
||||
<footer>
|
||||
<div class="container text-muted">
|
||||
<div class="row">
|
||||
<div class="col-md-3">
|
||||
Community
|
||||
<ul>
|
||||
<li><a href="https://github.com/FreeCAD/FreeCAD">Github</a></li>
|
||||
<li><a href="https://www.facebook.com/FreeCAD">Facebook</a></li>
|
||||
<li><a href="https://plus.google.com/u/0/communities/103183769032333474646">Google+</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-md-3">
|
||||
Learn
|
||||
<ul>
|
||||
<li><a href="https://www.freecadweb.org/wiki/Tutorials">Tutorials</a></li>
|
||||
<li><a href="https://www.youtube.com/results?search_query=freecad">Youtube videos</a></li>
|
||||
<li><a href="http://area51.stackexchange.com/proposals/88434/freecad">Stack Exchange</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-md-3">
|
||||
Help the project
|
||||
<ul>
|
||||
<li><a href="https://www.freecadweb.org/wiki/Help_FreeCAD">How can I help?</a></li>
|
||||
<li><a href="https://www.freecadweb.org/wiki/Donate"><i class="fa fa-heart"></i> Donate!</a></li>
|
||||
<li><a href="https://crowdin.com/project/freecad">Translate</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-md-3">
|
||||
Code
|
||||
<ul>
|
||||
<li><a href="https://www.freecadweb.org/wiki/Compiling">Building from source</a></li>
|
||||
<li><a href="https://www.freecadweb.org/api/">C++ & Python API</a></li>
|
||||
<li><a href="https://www.freecadweb.org/wiki/Licence">License information</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen $doxygenversion"/>
|
||||
|
||||
<script type="text/javascript" src="//www.freecadweb.org/js/jquery-2.1.4.min.js"></script>
|
||||
<script type="text/javascript" src="$relpath^jquery.js"></script>
|
||||
|
||||
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
|
||||
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
|
||||
@@ -21,59 +21,16 @@
|
||||
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
|
||||
$extrastylesheet
|
||||
<link href='//fonts.googleapis.com/css?family=Roboto+Slab' rel='stylesheet' type='text/css'>
|
||||
<link rel="stylesheet" href="//www.freecadweb.org/css/bootstrap-3.3.5.min.css">
|
||||
<link rel="stylesheet" href="//www.freecadweb.org/css/font-awesome-4.4.0.min.css">
|
||||
<link rel="stylesheet" href="//www.freecadweb.org/css/freecad.css">
|
||||
<script src="//www.freecadweb.org/js/bootstrap-3.3.5.min.js"></script>
|
||||
<link rel="stylesheet" href="$relpath^freecad.css">
|
||||
<script type="text/javascript" src="$relpath^doxy-boot.js"></script>
|
||||
<link rel="shortcut icon" href="//www.freecadweb.org/images/favicon.ico">
|
||||
<link rel="shortcut icon" href="favicon.ico">
|
||||
</head>
|
||||
<body>
|
||||
<div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
|
||||
<div class="container">
|
||||
<div class="navbar-header">
|
||||
<button class="navbar-toggle collapsed" data-toggle="collapse" data-target=".navbar-collapse">
|
||||
<span class="sr-only"><?php echo _('Toggle navigation'); ?></span>
|
||||
<span class="icon-bar"></span>
|
||||
<span class="icon-bar"></span>
|
||||
<span class="icon-bar"></span>
|
||||
</button>
|
||||
<a class="navbar-brand" href="/"><img alt="FreeCAD-logo" src="//www.freecadweb.org/images/logo.png"/> FreeCAD</a>
|
||||
</div>
|
||||
<div class="collapse navbar-collapse">
|
||||
<ul class="nav navbar-nav">
|
||||
<li><a href="/api/index.html" title="Welcome page">API Home</a></li>
|
||||
<li><a href="/api/modules.html" title="List of FreeCAD Modules">Modules</a></li>
|
||||
<li class="dropdown">
|
||||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Contents <span class="caret"></span></a>
|
||||
<ul class="dropdown-menu">
|
||||
<li><a href="/api/annotated.html" title="Annotated list">Annotated list</a></li>
|
||||
<li><a href="/api/namespaces.html" title="Namespaces">Namespaces</a></li>
|
||||
<li><a href="/api/classes.html" title="Classes">Classes</a></li>
|
||||
<li><a href="/api/functions.html" title="Functions">Functions</a></li>
|
||||
<li><a href="/api/hierarchy.html" title="Tree view of classes">Class hierarchy</a></li>
|
||||
<li><a href="/api/page.html" title="Related pages">Related pages</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="https://github.com/FreeCAD/FreeCAD" title="Browse the source code on GitHub">Source code</a></li>
|
||||
</ul>
|
||||
<ul class="nav navbar-nav navbar-right">
|
||||
<form class="navbar-search navbar-form" action="//duckduckgo.com/" id="searchform" role="search" method="get">
|
||||
<div>
|
||||
<input type="hidden" name="sites" value="freecadweb.org"/>
|
||||
<input type="text" name="q" class="form-control" placeholder="Search" title="Search FreeCAD documentation, forum and bugs" maxlength=300>
|
||||
<input type="submit" name="title" value="DuckDuckGo Search" style="width: 0; visibility: hidden;">
|
||||
</div>
|
||||
</form>
|
||||
</ul>
|
||||
<ul class="nav navbar-nav navbar-right">
|
||||
<li><a title="Forum" href="http://forum.freecadweb.org"><i class="fa fa-commenting"></i></a></li>
|
||||
<li><a title="Wiki" href="/wiki/"><i class="fa fa-book"></i></a></li>
|
||||
<li><a title="Tracker" href="/tracker/"><i class="fa fa-bug"></i></a></li>
|
||||
</ul>
|
||||
</div><!--/.nav-collapse -->
|
||||
</div>
|
||||
</div>
|
||||
<ul class="navbar" role="navigation">
|
||||
<li><a href="$relpath^index.html" title="Index">Index</a></li>
|
||||
<li><a href="$relpath^modules.html" title="Modules list">Modules Hierarchy</a></li>
|
||||
<li><a href="$relpath^annotated.html" title="Annotated list">Alphabetical list</a></li>
|
||||
</ul>
|
||||
|
||||
<div id="top" class="maincontents"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div class="content" id="content">
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** \defgroup GUI Gui side
|
||||
/** \defgroup GUI Gui
|
||||
* \ingroup CORE
|
||||
* \brief The Graphical User Interface of FreeCAD and the 3D View
|
||||
*/
|
||||
|
||||
@@ -29,13 +29,13 @@ __title__="FreeCAD Addon Manager Module"
|
||||
__author__ = "Yorik van Havre","Jonathan Wiedemann","Kurt Kremitzki"
|
||||
__url__ = "http://www.freecadweb.org"
|
||||
|
||||
'''
|
||||
"""
|
||||
FreeCAD Addon Manager Module
|
||||
|
||||
It will fetch its contents from https://github.com/FreeCAD/FreeCAD-addons
|
||||
You need a working internet connection, and optionally the GitPython package
|
||||
installed.
|
||||
'''
|
||||
"""
|
||||
|
||||
import os
|
||||
import re
|
||||
@@ -51,10 +51,13 @@ from addonmanager_workers import *
|
||||
def QT_TRANSLATE_NOOP(ctx,txt):
|
||||
return txt
|
||||
|
||||
## \defgroup ADDONMANAGER AddonManager
|
||||
# \ingroup ADDONMANAGER
|
||||
# \brief The Addon Manager allows to install workbenches and macros made by users
|
||||
# @{
|
||||
|
||||
class CommandAddonManager:
|
||||
|
||||
"The Addon Manager command"
|
||||
"""The main Addon Manager class and FreeCAD command"""
|
||||
|
||||
def GetResources(self):
|
||||
|
||||
@@ -79,6 +82,8 @@ class CommandAddonManager:
|
||||
|
||||
def launch(self):
|
||||
|
||||
"""Shows the Addon Manager UI"""
|
||||
|
||||
import FreeCADGui
|
||||
from PySide import QtGui
|
||||
|
||||
@@ -155,7 +160,7 @@ class CommandAddonManager:
|
||||
|
||||
def reject(self):
|
||||
|
||||
"called when the window has been closed"
|
||||
"""called when the window has been closed"""
|
||||
|
||||
# save window geometry and splitter state for next use
|
||||
pref = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Addons")
|
||||
@@ -200,7 +205,7 @@ class CommandAddonManager:
|
||||
|
||||
def update(self):
|
||||
|
||||
"updates the list of workbenches"
|
||||
"""updates the list of workbenches"""
|
||||
|
||||
self.dialog.listWorkbenches.clear()
|
||||
self.dialog.buttonExecute.setEnabled(False)
|
||||
@@ -231,7 +236,7 @@ class CommandAddonManager:
|
||||
|
||||
def apply_updates(self):
|
||||
|
||||
"apply all available updates"
|
||||
"""apply all available updates"""
|
||||
|
||||
if self.doUpdate:
|
||||
self.install(self.doUpdate)
|
||||
@@ -239,7 +244,7 @@ class CommandAddonManager:
|
||||
|
||||
def enable_updates(self,num):
|
||||
|
||||
"enables the update button"
|
||||
"""enables the update button"""
|
||||
|
||||
if num:
|
||||
self.dialog.buttonUpdateAll.setText(translate("AddonsInstaller","Apply")+" "+str(num)+" "+translate("AddonsInstaller","update(s)"))
|
||||
@@ -250,7 +255,7 @@ class CommandAddonManager:
|
||||
|
||||
def add_addon_repo(self, addon_repo):
|
||||
|
||||
"adds a workbench to the list"
|
||||
"""adds a workbench to the list"""
|
||||
|
||||
from PySide import QtGui
|
||||
self.repos.append(addon_repo)
|
||||
@@ -267,7 +272,7 @@ class CommandAddonManager:
|
||||
|
||||
def show_information(self, label):
|
||||
|
||||
"shows text in the information pane"
|
||||
"""shows text in the information pane"""
|
||||
|
||||
self.dialog.description.setText(label)
|
||||
if self.dialog.listWorkbenches.isVisible():
|
||||
@@ -277,7 +282,7 @@ class CommandAddonManager:
|
||||
|
||||
def show(self,idx):
|
||||
|
||||
"loads information of a given workbench"
|
||||
"""loads information of a given workbench"""
|
||||
|
||||
# this function is triggered also when the list is populated, prevent that here
|
||||
if idx == 0 and self.firsttime:
|
||||
@@ -300,7 +305,7 @@ class CommandAddonManager:
|
||||
|
||||
def show_macro(self,idx):
|
||||
|
||||
"loads information of a given macro"
|
||||
"""loads information of a given macro"""
|
||||
|
||||
# this function is triggered when the list is populated, prevent that here
|
||||
if idx == 0 and self.firstmacro:
|
||||
@@ -328,7 +333,7 @@ class CommandAddonManager:
|
||||
|
||||
def switchtab(self,idx):
|
||||
|
||||
"does what needs to be done when switching tabs"
|
||||
"""does what needs to be done when switching tabs"""
|
||||
|
||||
if idx == 1:
|
||||
if not self.macros:
|
||||
@@ -343,13 +348,13 @@ class CommandAddonManager:
|
||||
|
||||
def update_repos(self, repos):
|
||||
|
||||
"convenience function to update the internal list of workbenches"
|
||||
"""convenience function to update the internal list of workbenches"""
|
||||
|
||||
self.repos = repos
|
||||
|
||||
def add_macro(self, macro):
|
||||
|
||||
"adds a macro to the list"
|
||||
"""adds a macro to the list"""
|
||||
|
||||
if macro.name:
|
||||
if macro in self.macros:
|
||||
@@ -372,7 +377,7 @@ class CommandAddonManager:
|
||||
|
||||
def install(self,repos=None):
|
||||
|
||||
"installs a workbench or macro"
|
||||
"""installs a workbench or macro"""
|
||||
|
||||
if self.dialog.tabWidget.currentIndex() == 0:
|
||||
# Tab "Workbenches".
|
||||
@@ -405,7 +410,7 @@ class CommandAddonManager:
|
||||
|
||||
def show_progress_bar(self, state):
|
||||
|
||||
"shows or hides the progress bar"
|
||||
"""shows or hides the progress bar"""
|
||||
|
||||
if state == True:
|
||||
self.dialog.tabWidget.setEnabled(False)
|
||||
@@ -425,7 +430,7 @@ class CommandAddonManager:
|
||||
|
||||
def executemacro(self):
|
||||
|
||||
"executes a selected macro"
|
||||
"""executes a selected macro"""
|
||||
|
||||
import FreeCADGui
|
||||
if self.dialog.tabWidget.currentIndex() == 1:
|
||||
@@ -446,14 +451,14 @@ class CommandAddonManager:
|
||||
|
||||
def remove_readonly(self, func, path, _):
|
||||
|
||||
"Remove a read-only file."
|
||||
"""Remove a read-only file."""
|
||||
|
||||
os.chmod(path, stat.S_IWRITE)
|
||||
func(path)
|
||||
|
||||
def remove(self):
|
||||
|
||||
"uninstalls a macro or workbench"
|
||||
"""uninstalls a macro or workbench"""
|
||||
|
||||
if self.dialog.tabWidget.currentIndex() == 0:
|
||||
# Tab "Workbenches".
|
||||
@@ -479,7 +484,7 @@ class CommandAddonManager:
|
||||
|
||||
def mark_recompute(self,addon):
|
||||
|
||||
"marks an addon in the list as installed but needs recompute"
|
||||
"""marks an addon in the list as installed but needs recompute"""
|
||||
|
||||
for i in range(self.dialog.listWorkbenches.count()):
|
||||
txt = self.dialog.listWorkbenches.item(i).text().strip()
|
||||
@@ -494,8 +499,8 @@ class CommandAddonManager:
|
||||
|
||||
def update_status(self,soft=False):
|
||||
|
||||
"""Updates the list of workbenches/macros.
|
||||
If soft is true, items are not recreated (and therefore display text isn't triggered)"
|
||||
"""Updates the list of workbenches/macros. If soft is true, items
|
||||
are not recreated (and therefore display text isn't triggered)"
|
||||
"""
|
||||
|
||||
moddir = FreeCAD.getUserAppDataDir() + os.sep + "Mod"
|
||||
@@ -547,7 +552,7 @@ class CommandAddonManager:
|
||||
|
||||
def mark(self,repo):
|
||||
|
||||
"mark a workbench as updatable"
|
||||
"""mark a workbench as updatable"""
|
||||
|
||||
from PySide import QtGui
|
||||
for i in range(self.dialog.listWorkbenches.count()):
|
||||
@@ -560,7 +565,7 @@ class CommandAddonManager:
|
||||
|
||||
def show_config(self):
|
||||
|
||||
"shows the configuration dialog"
|
||||
"""shows the configuration dialog"""
|
||||
|
||||
import FreeCADGui
|
||||
from PySide import QtGui
|
||||
@@ -580,3 +585,5 @@ class CommandAddonManager:
|
||||
# OK button has been pressed
|
||||
pref.SetBool("AutoCheck",self.config.checkUpdates.isChecked())
|
||||
pref.SetString("CustomRepositories",self.config.customRepositories.toPlainText())
|
||||
|
||||
## @}
|
||||
|
||||
4
src/Mod/AddonManager/addonmanager.dox
Normal file
4
src/Mod/AddonManager/addonmanager.dox
Normal file
@@ -0,0 +1,4 @@
|
||||
/** \defgroup ADDONMANAGER Addon Manager
|
||||
* \ingroup PYTHONWORKBENCHES
|
||||
* \brief Application that handles the installation of user-made workbenches and macros
|
||||
*/
|
||||
@@ -21,6 +21,10 @@
|
||||
#* *
|
||||
#***************************************************************************
|
||||
|
||||
## @package AddonManager_macro
|
||||
# \ingroup ADDONMANAGER
|
||||
# \brief Unified handler for FreeCAD macros that can be obtained from different sources
|
||||
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
@@ -31,6 +35,8 @@ from addonmanager_utilities import urlopen
|
||||
|
||||
|
||||
class Macro(object):
|
||||
"""This class provides a unified way to handle macros coming from different sources"""
|
||||
|
||||
def __init__(self, name):
|
||||
self.name = name
|
||||
self.on_wiki = False
|
||||
|
||||
@@ -27,6 +27,10 @@ import FreeCAD
|
||||
import shutil
|
||||
import re
|
||||
|
||||
## @package AddonManager_utilities
|
||||
# \ingroup ADDONMANAGER
|
||||
# \brief Utilities to work across different platforms, providers and python versions
|
||||
|
||||
# check for SSL support
|
||||
|
||||
ssl_ctx = None
|
||||
|
||||
@@ -35,19 +35,22 @@ import addonmanager_utilities as utils
|
||||
from addonmanager_utilities import translate # this needs to be as is for pylupdate
|
||||
from addonmanager_macro import Macro
|
||||
|
||||
## @package AddonManager_workers
|
||||
# \ingroup ADDONMANAGER
|
||||
# \brief Multithread workers for the addon manager
|
||||
|
||||
MACROS_BLACKLIST = ["BOLTS","WorkFeatures","how to install","PartsLibrary","FCGear"]
|
||||
OBSOLETE = ["assembly2","drawing_dimensioning","cura_engine"] # These addons will print an additional message informing the user
|
||||
NOGIT = False # for debugging purposes, set this to True to always use http downloads
|
||||
|
||||
|
||||
|
||||
"Multithread workers for the Addon Manager"
|
||||
"""Multithread workers for the Addon Manager"""
|
||||
|
||||
|
||||
|
||||
class UpdateWorker(QtCore.QThread):
|
||||
|
||||
"This worker updates the list of available workbenches"
|
||||
"""This worker updates the list of available workbenches"""
|
||||
|
||||
info_label = QtCore.Signal(str)
|
||||
addon_repo = QtCore.Signal(object)
|
||||
@@ -119,8 +122,7 @@ class UpdateWorker(QtCore.QThread):
|
||||
|
||||
|
||||
class InfoWorker(QtCore.QThread):
|
||||
|
||||
"This worker retrieves the description text of a workbench"
|
||||
"""This worker retrieves the description text of a workbench"""
|
||||
|
||||
addon_repos = QtCore.Signal(object)
|
||||
|
||||
@@ -153,8 +155,7 @@ class InfoWorker(QtCore.QThread):
|
||||
|
||||
|
||||
class CheckWBWorker(QtCore.QThread):
|
||||
|
||||
"This worker checks for available updates for all workbenches"
|
||||
"""This worker checks for available updates for all workbenches"""
|
||||
|
||||
enable = QtCore.Signal(int)
|
||||
mark = QtCore.Signal(str)
|
||||
@@ -212,8 +213,7 @@ class CheckWBWorker(QtCore.QThread):
|
||||
|
||||
|
||||
class FillMacroListWorker(QtCore.QThread):
|
||||
|
||||
"This worker opulates the list of macros"
|
||||
"""This worker opulates the list of macros"""
|
||||
|
||||
add_macro_signal = QtCore.Signal(Macro)
|
||||
info_label_signal = QtCore.Signal(str)
|
||||
@@ -293,8 +293,7 @@ class FillMacroListWorker(QtCore.QThread):
|
||||
|
||||
|
||||
class ShowWorker(QtCore.QThread):
|
||||
|
||||
"This worker retrieves info of a given workbench"
|
||||
"""This worker retrieves info of a given workbench"""
|
||||
|
||||
info_label = QtCore.Signal(str)
|
||||
addon_repos = QtCore.Signal(object)
|
||||
|
||||
5
src/Mod/Arch/Dice3DS/dice3ds.dox
Normal file
5
src/Mod/Arch/Dice3DS/dice3ds.dox
Normal file
@@ -0,0 +1,5 @@
|
||||
/**
|
||||
\defgroup DICE3DS Dice 3DS
|
||||
\ingroup EMBEDDED
|
||||
\brief The Dice 3DS library provides 3DStudio files import to the Arch module
|
||||
*/
|
||||
@@ -22,8 +22,16 @@
|
||||
#* *
|
||||
#***************************************************************************
|
||||
|
||||
## \defgroup OFFLINERENDERINGUTILS OfflineRenderingUtils
|
||||
# \ingroup UTILITIES
|
||||
# \brief Utility functions to work with FreeCAD files in console mode
|
||||
#
|
||||
# Offline rendering utilities
|
||||
|
||||
"""
|
||||
## \addtogroup OFFLINERENDERINGUTILS
|
||||
# @{
|
||||
|
||||
"""@package docstring
|
||||
OfflineRenderingUtils - Utilities to help producing files with colors from FreeCAD in non-GUI mode
|
||||
|
||||
|
||||
@@ -96,7 +104,6 @@ OfflineRenderingUtils.viewer(scene)
|
||||
OfflineRenderingUtils.save(doc,filename=baseFileName+"_exported.FCStd",colors=colors,camera=camera)
|
||||
"""
|
||||
|
||||
|
||||
import sys
|
||||
import os
|
||||
import xml.sax
|
||||
@@ -749,3 +756,5 @@ def extract(filename,inputpath,outputpath=None):
|
||||
of.close()
|
||||
else:
|
||||
return data
|
||||
|
||||
## @}
|
||||
|
||||
@@ -26,7 +26,7 @@ __author__ = "Yorik van Havre, Jacques-Antoine Gaudin, Ken Cline"
|
||||
__url__ = ["http://www.freecadweb.org"]
|
||||
|
||||
## \defgroup DRAFTGEOMUTILS DraftGeomUtils
|
||||
# \ingroup DRAFT
|
||||
# \ingroup UTILITIES
|
||||
# \brief Shape manipulation utilities for the Draft workbench
|
||||
#
|
||||
# Shapes manipulation utilities
|
||||
|
||||
@@ -28,7 +28,7 @@ __url__ = ["http://www.freecadweb.org"]
|
||||
"a vector math library for FreeCAD"
|
||||
|
||||
## \defgroup DRAFTVECUTILS DraftVecUtils
|
||||
# \ingroup DRAFT
|
||||
# \ingroup UTILITIES
|
||||
# \brief Vector math utilities used in Draft workbench
|
||||
#
|
||||
# Vector math utilities
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/** \defgroup FEM Fem
|
||||
* \ingroup CWORKBENCHES
|
||||
* \ingroup PYTHONWORKBENCHES
|
||||
* \brief Finite Elements Analysis workbench
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
|
||||
/** \defgroup WM4 WildMagic4
|
||||
* \ingroup MESH
|
||||
* \ingroup EMBEDDED
|
||||
* Excerpts from version 4.0.0 of Wild Magic Library which were integrated
|
||||
* to FreeCAD's Mesh module.
|
||||
*
|
||||
|
||||
@@ -24,6 +24,7 @@
|
||||
#define PARAMS_HELPER_H
|
||||
|
||||
/** \page ParamPage Parameter helper macros
|
||||
* \ingroup PATH
|
||||
* Collections of macros for managing groups of parameters.
|
||||
*
|
||||
* \section Motivation
|
||||
@@ -178,6 +179,7 @@
|
||||
#include <boost/preprocessor/comparison/greater.hpp>
|
||||
|
||||
/** \defgroup ParamHelper Parameters helper macros
|
||||
* \ingroup PATH
|
||||
* Collections of macros for managing groups of parameters */
|
||||
|
||||
/**
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** \defgroup PATH Path
|
||||
* \ingroup CWORKBENCHES
|
||||
* \ingroup PYTHONWORKBENCHES
|
||||
* \brief Tools to generate CNC toolpaths and G-Code
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/** \addtogroup WORKBENCHES
|
||||
Additional functionality and GUI tools
|
||||
Most of FreeCAD's functionality is defined in dedicated Workbenches
|
||||
|
||||
Those plugins, also called \b modules or \b worbenches, provide
|
||||
functionality for specialized facets of FreeCAD. The word \b module
|
||||
@@ -12,18 +12,16 @@
|
||||
Some of these modules are programmed in C++, others in Python, and some
|
||||
in a mix of C++ and Python.
|
||||
|
||||
\b Warning: Some are really work-in-progress and are not yet included in
|
||||
the official builds
|
||||
*/
|
||||
|
||||
/** \defgroup PYTHONWORKBENCHES Python workbenches
|
||||
* \ingroup WORKBENCHES
|
||||
* \brief Those are workbenches programmed fully in Python
|
||||
*/
|
||||
|
||||
/** \defgroup CWORKBENCHES C++ workbenches
|
||||
* \ingroup WORKBENCHES
|
||||
* \brief Those are workbenches programmed primarily in C++. They usually provide a Python API as well.
|
||||
* \brief These workbenches are programmed primarily in C++, but most provide a Python API as well.
|
||||
*/
|
||||
|
||||
/** \defgroup PYTHONWORKBENCHES Python workbenches
|
||||
* \ingroup WORKBENCHES
|
||||
* \brief Those are workbenches programmed primarily in Python
|
||||
*/
|
||||
|
||||
/** \defgroup UTILITIES Utility modules
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
/**
|
||||
\defgroup ZIPIOS Zipios++
|
||||
\ingroup EMBEDDED
|
||||
\brief C++ library for reading and writing Zip file
|
||||
|
||||
\section intro Introduction
|
||||
|
||||
|
||||
Reference in New Issue
Block a user