Skip to content

Commit

Permalink
Merge c95f530 into edda88f
Browse files Browse the repository at this point in the history
  • Loading branch information
awicenec committed Sep 6, 2021
2 parents edda88f + c95f530 commit 6dfdc94
Show file tree
Hide file tree
Showing 31 changed files with 200 additions and 370 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ dist
.settings
.pytest_cache
.vscode
.venv
daliuge-translator/dlg/translator/dropmake/web/VERSION
daliuge-translator/dlg/translator/dropmake/web/LICENSE
daliuge-engine/dlg/runtime/version.py
Expand Down
36 changes: 19 additions & 17 deletions ProcessingComponentBindingGuide.md → component_binding.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Install Doxygen
# Component Binding Guide

## Install Doxygen

http://www.doxygen.nl/

# Configure the configuration file (Doxyfile as default)
## Configure the configuration file (Doxyfile as default)

```python
# Doxyfile 1.8.# Doxyfile 1.8.17
Expand Down Expand Up @@ -150,11 +152,11 @@ ENABLE_PREPROCESSING   = NO
# The default value is: YES.
CLASS_DIAGRAMS         = NO
```
# Add comments in the source code files
## Add comments in the source code files

## Source Files
### Source Files

### **Filename**
#### **Filename**

The name of the source file

Expand All @@ -168,7 +170,7 @@ or
/##
# \file LoadVis.h
```
### **Description**
#### **Description**

A brief description of the purpose of this component. A detailed description is also included here.

Expand All @@ -183,7 +185,7 @@ A brief description of the purpose of this component. A detailed description is
# \brief Load Visibility
# \details Load a CASA Measurement Set in the DaliugeApplication Framework. We will build on the LoadParset structure - but use the contents of the parset to load a measurement set.
```
### Location
#### Location

The location of the file that generated this component description. Contains repository location, file path within repository and git commit hash.

Expand All @@ -196,14 +198,14 @@ Note: the value of $(GITLAB_REPO) will be substituted at run-time.
* \par EAGLE_END
*/
```
###
####
```python
/##
# \par EAGLE_START
# \param gitrepo $(GIT_REPO)
# \par EAGLE_END
```
### **Version**
#### **Version**

The version of the code file.

Expand All @@ -222,7 +224,7 @@ Note: the value of $(PROJECT_VERSION) will be substituted at run-time, and also
# \param version $(PROJECT_VERSION)
# \par EAGLE_END
```
### **Category**
#### **Category**

DynlibApp, DynlibProcApp, PythonApp, BashShellApp

Expand All @@ -233,16 +235,16 @@ DynlibApp, DynlibProcApp, PythonApp, BashShellApp
* \par EAGLE_END
*/
```
##
###
```python
/##
# \par EAGLE_START
# \param category DynlibApp
# \par EAGLE_END
```
## Parameters (Fields)
### Parameters (Fields)

### **Name, Description, Direction, Default Value, Data Type**
#### **Name, Description, Direction, Default Value, Data Type**

The pattern is:

Expand Down Expand Up @@ -272,7 +274,7 @@ The pattern is:
* \par EAGLE_END
*/
```
##
###
```python
/##
# \par EAGLE_START
Expand All @@ -290,9 +292,9 @@ The pattern is:
# \~
# \par EAGLE_END
```
## Ports/Local Ports
### Ports/Local Ports

### **Name, Description, Direction**
#### **Name, Description, Direction**

The pattern is:

Expand Down Expand Up @@ -344,7 +346,7 @@ The pattern is:
# \~
# \par EAGLE_END
```
# Run Doxygen
## Run Doxygen

If do not need the location and version of the current cod e , could just run

Expand Down
Loading

0 comments on commit 6dfdc94

Please sign in to comment.