File: Doc.h

package info (click to toggle)
storm-lang 0.7.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 52,004 kB
  • sloc: ansic: 261,462; cpp: 140,405; sh: 14,891; perl: 9,846; python: 2,525; lisp: 2,504; asm: 860; makefile: 678; pascal: 70; java: 52; xml: 37; awk: 12
file content (42 lines) | stat: -rw-r--r-- 747 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
#pragma once
#include "Core/SrcPos.h"
#include "Compiler/Doc.h"

namespace storm {
	namespace bs {
		STORM_PKG(lang.bs);

		/**
		 * Documentation for Storm functions.
		 */
		class BSDoc : public NamedDoc {
			STORM_CLASS;
		public:
			STORM_CTOR BSDoc(SrcPos docPos, Named *entity);

			// Get documentation.
			virtual Doc *STORM_FN get();

		protected:
			// Where is the documentation located?
			SrcPos docPos;

			// Which object?
			Named *entity;

		private:
			// Read the body of the documentation.
			Str *readBody();

			// Create parameters from 'entity' if possible.
			Array<DocParam> *createParams();
		};


		/**
		 * Apply documentation to supported objects.
		 */
		TObject *STORM_FN applyDoc(SrcPos start, TObject *to);

	}
}